{ "openapi" : "3.0.3", "info" : { "title" : "Amplify Engage API v1.90", "version" : "1.90.0", "contact" : { "name" : "Axway Support", "email" : "support@axway.com" }, "license" : { "name" : "Copyright Axway 2025. All rights reserved." }, "description" : "APIs to manage Amplify Engage configuration services.", "x-api-id" : "a68e7c9b-98bc-519d-9831-ee19d57a2613", "x-audience" : "axway-customer" }, "tags" : [ { "name" : "catalog", "description" : "Resources for group catalog" }, { "name" : "definitions", "description" : "Resources for group definitions" }, { "name" : "management", "description" : "Resources for group management" } ], "security" : [ { "BearerToken" : [ ] }, { "OAuth2" : [ ] } ], "servers" : [ { "url" : "https://apicentral.axway.com/apis" } ], "paths" : { "/management/v1alpha1/watchtopics" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves WatchTopic for version v1alpha1 from group management", "description" : "Retrieves WatchTopic for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type WatchTopic for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of watchtopics." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of WatchTopic for version v1alpha1 from group management", "description" : "Retrieves a count of WatchTopic for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of WatchTopic for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of watchtopics." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create WatchTopic for version v1alpha1 from group management", "description" : "Create WatchTopic for version v1alpha1 from group management", "operationId" : "create_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "responses" : { "201" : { "description" : "Create a new WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves WatchTopic for version v1alpha1 from group management", "description" : "Retrieves WatchTopic for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove WatchTopic for version v1alpha1 from group management", "description" : "Remove WatchTopic for version v1alpha1 from group management", "operationId" : "remove_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing WatchTopic for version v1alpha1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed WatchTopic for version v1alpha1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update WatchTopic for version v1alpha1 from group management", "description" : "Update WatchTopic for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "responses" : { "200" : { "description" : "Update WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch WatchTopic for version v1alpha1 from group management", "description" : "Patch WatchTopic for version v1alpha1 from group management", "operationId" : "patch_management_v1alpha1_WatchTopic", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of WatchTopic for version v1alpha1 from group management", "description" : "Retrieves Extension resource data of WatchTopic for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_WatchTopic_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of WatchTopic for version v1alpha1 from group management", "description" : "Update Extension resource data of WatchTopic for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_WatchTopic_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for WatchTopic for version v1alpha1 from group management", "description" : "Retrieves Languages data for WatchTopic for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_WatchTopic_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for WatchTopic for version v1alpha1 from group management", "description" : "Update Languages data for WatchTopic for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_WatchTopic_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for WatchTopic for version v1alpha1 from group management", "description" : "Retrieves Languages data for WatchTopic for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_WatchTopic_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for WatchTopic for version v1alpha1 from group management", "description" : "Update Languages data for WatchTopic for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_WatchTopic_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.WatchTopic resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for WatchTopic for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopic" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DiscoveryAgent for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of discoveryagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of discoveryagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Create DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "201" : { "description" : "Create a new DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Remove DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DiscoveryAgent for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DiscoveryAgent for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Update DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Patch DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/agentstate" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated agentstate resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/dataplane" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated dataplane resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/discoveryagents/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DiscoveryAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DiscoveryAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DiscoveryAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DiscoveryAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/discoveryagents" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DiscoveryAgent for version v1alpha1 from group management", "description" : "Retrieves DiscoveryAgent for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DiscoveryAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DiscoveryAgent for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of discoveryagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management", "description" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_DiscoveryAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DiscoveryAgent for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of discoveryagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Dataplane for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanes." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Dataplane for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanes." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Create Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "201" : { "description" : "Create a new Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Remove Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Dataplane for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Dataplane for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Update Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Patch Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}/secretschema" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane_secretschema", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane_secretschema", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Updated secretschema resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}/security" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane_security", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane_security", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Updated security resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanes/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Dataplane", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Dataplane_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Dataplane_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Dataplane for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/dataplanes" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Dataplane for version v1alpha1 from group management", "description" : "Retrieves Dataplane for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Dataplane resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, secretschema, security, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Dataplane for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanes." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Dataplane" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Dataplane for version v1alpha1 from group management", "description" : "Retrieves a count of Dataplane for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Dataplane", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Dataplane for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanes." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * state * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DataplaneSecret for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanesecrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * state * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanesecrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Create DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "201" : { "description" : "Create a new DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Remove DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DataplaneSecret for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DataplaneSecret for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Update DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Patch DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}/state" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/dataplanesecrets/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DataplaneSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_DataplaneSecret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_DataplaneSecret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DataplaneSecret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/dataplanesecrets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DataplaneSecret for version v1alpha1 from group management", "description" : "Retrieves DataplaneSecret for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * state * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.DataplaneSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DataplaneSecret for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanesecrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.DataplaneSecret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management", "description" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_DataplaneSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * state * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DataplaneSecret for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of dataplanesecrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type TraceabilityAgent for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of traceabilityagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of traceabilityagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Create TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "201" : { "description" : "Create a new TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Remove TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing TraceabilityAgent for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed TraceabilityAgent for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Update TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Patch TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/agentstate" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated agentstate resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/sampletrigger" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated sampletrigger resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/dataplane" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated dataplane resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/traceabilityagents/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the TraceabilityAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_TraceabilityAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_TraceabilityAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for TraceabilityAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/traceabilityagents" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves TraceabilityAgent for version v1alpha1 from group management", "description" : "Retrieves TraceabilityAgent for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.TraceabilityAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, sampletrigger, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type TraceabilityAgent for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of traceabilityagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.TraceabilityAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management", "description" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_TraceabilityAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of TraceabilityAgent for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of traceabilityagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ComplianceAgent for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Create ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "201" : { "description" : "Create a new ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Remove ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ComplianceAgent for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ComplianceAgent for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Update ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Patch ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/agentstate" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_agentstate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated agentstate resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/dataplane" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_dataplane", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated dataplane resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceagents/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceAgent", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceAgent_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ComplianceAgent for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/complianceagents" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceAgent for version v1alpha1 from group management", "description" : "Retrieves ComplianceAgent for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceAgent resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, agentstate, dataplane, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ComplianceAgent for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceagents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceAgent" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management", "description" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ComplianceAgent", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.state * status.version * agentstate.update * status.lastActivityTime * spec.dataplaneType * status.sdkVersion * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ComplianceAgent for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceagents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/stages" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Stage for version v1alpha1 from group catalog", "description" : "Retrieves Stage for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Stage for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stages." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Stage for version v1alpha1 from group catalog", "description" : "Retrieves a count of Stage for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Stage for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stages." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Stage for version v1alpha1 from group catalog", "description" : "Create Stage for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "201" : { "description" : "Create a new Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Stage for version v1alpha1 from group catalog", "description" : "Retrieves Stage for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Stage for version v1alpha1 from group catalog", "description" : "Remove Stage for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Stage for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Stage for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Stage for version v1alpha1 from group catalog", "description" : "Update Stage for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "200" : { "description" : "Update Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Stage for version v1alpha1 from group catalog", "description" : "Patch Stage for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Stage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Stage for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of Stage for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Stage_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Stage for version v1alpha1 from group catalog", "description" : "Update icon resource data of Stage for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Stage_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Stage for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Stage for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Stage_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Stage for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Stage for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Stage_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Stage for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Stage for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Stage_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Stage for version v1alpha1 from group catalog", "description" : "Update Languages data for Stage for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Stage_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Stage for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Stage for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Stage_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Stage for version v1alpha1 from group catalog", "description" : "Update Languages data for Stage for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Stage_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Stage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Stage for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Stage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Asset for version v1alpha1 from group catalog", "description" : "Retrieves Asset for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * spec.type * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, access, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Asset for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Asset for version v1alpha1 from group catalog", "description" : "Retrieves a count of Asset for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * spec.type * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Asset for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Asset for version v1alpha1 from group catalog", "description" : "Create Asset for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, access, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "201" : { "description" : "Create a new Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Asset for version v1alpha1 from group catalog", "description" : "Retrieves Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, access, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Asset for version v1alpha1 from group catalog", "description" : "Remove Asset for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Asset for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Asset for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Asset for version v1alpha1 from group catalog", "description" : "Update Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, access, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Update Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Asset for version v1alpha1 from group catalog", "description" : "Patch Asset for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Asset", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, access, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/access" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves access resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves access resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_access", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read access resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update access resource data of Asset for version v1alpha1 from group catalog", "description" : "Update access resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_access", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated access resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Asset for version v1alpha1 from group catalog", "description" : "Update icon resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/latestrelease" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves latestrelease resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves latestrelease resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_latestrelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read latestrelease resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update latestrelease resource data of Asset for version v1alpha1 from group catalog", "description" : "Update latestrelease resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_latestrelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated latestrelease resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Asset for version v1alpha1 from group catalog", "description" : "Update status resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Asset for version v1alpha1 from group catalog", "description" : "Update state resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Asset for version v1alpha1 from group catalog", "description" : "Update references resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Asset for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Asset for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Asset for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Asset for version v1alpha1 from group catalog", "description" : "Update Languages data for Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Asset for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Asset for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Asset_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Asset for version v1alpha1 from group catalog", "description" : "Update Languages data for Asset for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Asset_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Asset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Asset for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Asset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves AssetRelease for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.version * status.level * spec.type * spec.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, icon, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetRelease for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetreleases." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssetRelease for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.version * status.level * spec.type * spec.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetRelease for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetreleases." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetRelease for version v1alpha1 from group catalog", "description" : "Create AssetRelease for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, icon, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "201" : { "description" : "Create a new AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, icon, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetRelease for version v1alpha1 from group catalog", "description" : "Remove AssetRelease for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetRelease for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetRelease for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetRelease for version v1alpha1 from group catalog", "description" : "Update AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, icon, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Update AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetRelease for version v1alpha1 from group catalog", "description" : "Patch AssetRelease for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_AssetRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, icon, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Update status resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Update icon resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Update references resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetRelease for version v1alpha1 from group catalog", "description" : "Update Extension resource data of AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRelease for version v1alpha1 from group catalog", "description" : "Update Languages data for AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRelease for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for AssetRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AssetRelease_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRelease for version v1alpha1 from group catalog", "description" : "Update Languages data for AssetRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AssetRelease_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Category for version v1 from group catalog", "description" : "Retrieves Category for version v1 from group catalog", "operationId" : "list_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.restriction.marketplace.visible * spec.parentCategory * spec.restriction.type * spec.restriction.marketplace.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Category for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categories." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Category for version v1 from group catalog", "description" : "Retrieves a count of Category for version v1 from group catalog", "operationId" : "count_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.restriction.marketplace.visible * spec.parentCategory * spec.restriction.type * spec.restriction.marketplace.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Category for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categories." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Category for version v1 from group catalog", "description" : "Create Category for version v1 from group catalog", "operationId" : "create_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "201" : { "description" : "Create a new Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Category for version v1 from group catalog", "description" : "Retrieves Category for version v1 from group catalog", "operationId" : "read_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Category for version v1 from group catalog", "description" : "Remove Category for version v1 from group catalog", "operationId" : "remove_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Category for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Category for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Category for version v1 from group catalog", "description" : "Update Category for version v1 from group catalog", "operationId" : "update_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "200" : { "description" : "Update Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Category for version v1 from group catalog", "description" : "Patch Category for version v1 from group catalog", "operationId" : "patch_catalog_v1_Category", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Category for version v1 from group catalog", "description" : "Retrieves icon resource data of Category for version v1 from group catalog", "operationId" : "read_catalog_v1_Category_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Category for version v1 from group catalog", "description" : "Update icon resource data of Category for version v1 from group catalog", "operationId" : "update_catalog_v1_Category_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Category for version v1 from group catalog", "description" : "Retrieves Extension resource data of Category for version v1 from group catalog", "operationId" : "read_catalog_v1_Category_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Category for version v1 from group catalog", "description" : "Update Extension resource data of Category for version v1 from group catalog", "operationId" : "update_catalog_v1_Category_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Category for version v1 from group catalog", "description" : "Retrieves Languages data for Category for version v1 from group catalog", "operationId" : "read_catalog_v1_Category_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Category for version v1 from group catalog", "description" : "Update Languages data for Category for version v1 from group catalog", "operationId" : "update_catalog_v1_Category_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categories/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Category for version v1 from group catalog", "description" : "Retrieves Languages data for Category for version v1 from group catalog", "operationId" : "read_catalog_v1_Category_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Category for version v1 from group catalog", "description" : "Update Languages data for Category for version v1 from group catalog", "operationId" : "update_catalog_v1_Category_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Category for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Category for version v1alpha1 from group catalog", "description" : "Retrieves Category for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.restriction.marketplace.visible * spec.parentCategory * spec.restriction.type * spec.restriction.marketplace.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Category for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categories." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Category for version v1alpha1 from group catalog", "description" : "Retrieves a count of Category for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.restriction.marketplace.visible * spec.parentCategory * spec.restriction.type * spec.restriction.marketplace.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Category for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categories." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Category for version v1alpha1 from group catalog", "description" : "Create Category for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "201" : { "description" : "Create a new Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Category for version v1alpha1 from group catalog", "description" : "Retrieves Category for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Category for version v1alpha1 from group catalog", "description" : "Remove Category for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Category for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Category for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Category for version v1alpha1 from group catalog", "description" : "Update Category for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "200" : { "description" : "Update Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Category for version v1alpha1 from group catalog", "description" : "Patch Category for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Category", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Category for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of Category for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Category_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Category for version v1alpha1 from group catalog", "description" : "Update icon resource data of Category for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Category_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Category for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Category for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Category_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Category for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Category for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Category_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Category for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Category for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Category_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Category for version v1alpha1 from group catalog", "description" : "Update Languages data for Category for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Category_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Category for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Category for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Category_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Category for version v1alpha1 from group catalog", "description" : "Update Languages data for Category for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Category_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Category resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Category for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Category" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, policies, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AuthorizationProfile for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of authprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves a count of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AuthorizationProfile for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of authprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Create AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, policies, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "201" : { "description" : "Create a new AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, policies, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Remove AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AuthorizationProfile for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AuthorizationProfile for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, policies, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Update AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Patch AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, policies, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}/policies" : { "parameters" : [ { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_policies", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_policies", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Updated policies resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "description" : "Update Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AuthorizationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AuthorizationProfile for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AuthorizationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Application for version v1alpha1 from group catalog", "description" : "Retrieves Application for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * marketplace.resource.owner.id * state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Application for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applications." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Application for version v1alpha1 from group catalog", "description" : "Retrieves a count of Application for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * marketplace.resource.owner.id * state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Application for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applications." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Application for version v1alpha1 from group catalog", "description" : "Create Application for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "201" : { "description" : "Create a new Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Application for version v1alpha1 from group catalog", "description" : "Retrieves Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Application for version v1alpha1 from group catalog", "description" : "Remove Application for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Application for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Application for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Application for version v1alpha1 from group catalog", "description" : "Update Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Update Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Application for version v1alpha1 from group catalog", "description" : "Patch Application for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Application", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}/marketplace" : { "parameters" : [ { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of Application for version v1alpha1 from group catalog", "description" : "Retrieves marketplace resource data of Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of Application for version v1alpha1 from group catalog", "description" : "Update marketplace resource data of Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Application for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Application for version v1alpha1 from group catalog", "description" : "Update state resource data of Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Application for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Application for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Application for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Application for version v1alpha1 from group catalog", "description" : "Update Languages data for Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Application for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Application for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Application_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Application for version v1alpha1 from group catalog", "description" : "Update Languages data for Application for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Application_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Application resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Application for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Application" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}/webhooks" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_webhooks", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_webhooks", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}/references" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/credentialrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_CredentialRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CredentialRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/credentialrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CredentialRequestDefinition for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CredentialRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_CredentialRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "list_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * scopeResource.marketplace.resource.owner.id * status.level * spec.state.name * policies.expiry.timestamp * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Credential for version v1alpha1 from group catalog in scope Application", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves a count of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "count_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * scopeResource.marketplace.resource.owner.id * status.level * spec.state.name * policies.expiry.timestamp * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Credential for version v1alpha1 from group catalog in scope Application.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Credential for version v1alpha1 from group catalog in scope Application", "description" : "Create Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "create_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "201" : { "description" : "Create a new Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Credential for version v1alpha1 from group catalog in scope Application", "description" : "Remove Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "remove_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Credential for version v1alpha1 from group catalog in scope Application. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Credential for version v1alpha1 from group catalog in scope Application" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Update Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Credential for version v1alpha1 from group catalog in scope Application", "description" : "Patch Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "patch_catalog_v1alpha1_Application_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/references" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves references resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update references resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/data" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves data resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves data resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_data", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read data resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update data resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update data resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_data", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated data resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/state" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves state resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update state resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/policies" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_policies", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_policies", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated policies resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/expiration" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_expiration", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_expiration", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated expiration resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/marketplace" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/status" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves status resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update status resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/{extension}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/languages" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/credentials/{name}/languages-{code}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Credential for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_Credential_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Credential for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for Credential for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_Credential_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Credential for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/credentials" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group catalog", "description" : "Retrieves Credential for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Credential", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * scopeResource.marketplace.resource.owner.id * status.level * spec.state.name * policies.expiry.timestamp * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, expiration, marketplace, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Credential for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Credential" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Credential for version v1alpha1 from group catalog", "description" : "Retrieves a count of Credential for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Credential", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * scopeResource.marketplace.resource.owner.id * status.level * spec.state.name * policies.expiry.timestamp * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Credential for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/subscriptions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Subscription for version v1alpha1 from group catalog", "description" : "Retrieves Subscription for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * status.level * state.when.timestamp * marketplace.resource.owner.id * billing.payment.type * approval.previousState * marketplace.resource.owner.user.id * approval.state * billing.type * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, marketplace, approval, status, references, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Subscription for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves a count of Subscription for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * status.level * state.when.timestamp * marketplace.resource.owner.id * billing.payment.type * approval.previousState * marketplace.resource.owner.user.id * approval.state * billing.type * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Subscription for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Subscription for version v1alpha1 from group catalog", "description" : "Create Subscription for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, marketplace, approval, status, references, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "201" : { "description" : "Create a new Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Subscription for version v1alpha1 from group catalog", "description" : "Retrieves Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, marketplace, approval, status, references, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Subscription for version v1alpha1 from group catalog", "description" : "Remove Subscription for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Subscription for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Subscription for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Subscription for version v1alpha1 from group catalog", "description" : "Update Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, marketplace, approval, status, references, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Update Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Subscription for version v1alpha1 from group catalog", "description" : "Patch Subscription for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Subscription", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, marketplace, approval, status, references, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/billing" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves billing resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves billing resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read billing resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update billing resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update billing resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated billing resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/marketplace" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves marketplace resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update marketplace resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/approval" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves approval resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves approval resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_approval", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read approval resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update approval resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update approval resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_approval", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated approval resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update status resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update references resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update state resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Subscription for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Subscription for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Subscription for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Subscription for version v1alpha1 from group catalog", "description" : "Update Languages data for Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Subscription for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Subscription for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Subscription_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Subscription for version v1alpha1 from group catalog", "description" : "Update Languages data for Subscription for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Subscription_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Subscription resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Subscription for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Subscription" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "list_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.marketplace.resource.owner.id * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.organization.id * scopeResource.billing.type * scopeResource.state.when.timestamp * scopeResource.approval.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "count_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.marketplace.resource.owner.id * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.organization.id * scopeResource.billing.type * scopeResource.state.when.timestamp * scopeResource.approval.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Create SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "create_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "201" : { "description" : "Create a new SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs/{name}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Remove SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "remove_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SubscriptionJob for version v1alpha1 from group catalog in scope Subscription. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SubscriptionJob for version v1alpha1 from group catalog in scope Subscription" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Update SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Patch SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "patch_catalog_v1alpha1_Subscription_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs/{name}/status" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionJob_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Update status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionJob_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs/{name}/{extension}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionJob_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionJob_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs/{name}/languages" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionJob_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionJob_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptionjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionJob_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionJob_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionJob for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog", "description" : "Retrieves SubscriptionJob for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.marketplace.resource.owner.id * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.organization.id * scopeResource.billing.type * scopeResource.state.when.timestamp * scopeResource.approval.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionJob for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog", "description" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_SubscriptionJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.marketplace.resource.owner.id * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.organization.id * scopeResource.billing.type * scopeResource.state.when.timestamp * scopeResource.approval.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionJob for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "list_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * billing.dueDate * billing.payment.id * billing.payment.dueDate * scopeResource.approval.previousState * scopeResource.state.name * billing.payment.amount.currency * scopeResource.state.when.timestamp * billing.amount.currency * marketplace.resource.owner.organization.id * invoiced.amount.currency * billing.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * billing.payment.issueDate * scopeResource.marketplace.resource.owner.id * spec.period.to * billing.payment.type * billing.customer.id * billing.payment.number * spec.period.from * spec.cost.plan.currency * billing.payment.customer.id * state.name * status.level * billing.issueDate * billing.number * marketplace.resource.owner.id * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.type * billing.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptioninvoices." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "count_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * billing.dueDate * billing.payment.id * billing.payment.dueDate * scopeResource.approval.previousState * scopeResource.state.name * billing.payment.amount.currency * scopeResource.state.when.timestamp * billing.amount.currency * marketplace.resource.owner.organization.id * invoiced.amount.currency * billing.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * billing.payment.issueDate * scopeResource.marketplace.resource.owner.id * spec.period.to * billing.payment.type * billing.customer.id * billing.payment.number * spec.period.from * spec.cost.plan.currency * billing.payment.customer.id * state.name * status.level * billing.issueDate * billing.number * marketplace.resource.owner.id * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.type * billing.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptioninvoices." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Create SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "create_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "201" : { "description" : "Create a new SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Remove SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "remove_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Patch SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "patch_catalog_v1alpha1_Subscription_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/references" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/marketplace" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/state" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/invoiced" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_invoiced", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_invoiced", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated invoiced resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/billing" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated billing resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/status" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/{extension}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/languages" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/subscriptioninvoices/{name}/languages-{code}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionInvoice", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_SubscriptionInvoice_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_SubscriptionInvoice_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionInvoice for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptioninvoices" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog", "description" : "Retrieves SubscriptionInvoice for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * billing.dueDate * billing.payment.id * billing.payment.dueDate * scopeResource.approval.previousState * scopeResource.state.name * billing.payment.amount.currency * scopeResource.state.when.timestamp * billing.amount.currency * marketplace.resource.owner.organization.id * invoiced.amount.currency * billing.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * billing.payment.issueDate * scopeResource.marketplace.resource.owner.id * spec.period.to * billing.payment.type * billing.customer.id * billing.payment.number * spec.period.from * spec.cost.plan.currency * billing.payment.customer.id * state.name * status.level * billing.issueDate * billing.number * marketplace.resource.owner.id * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.type * billing.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionInvoice resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, marketplace, state, invoiced, billing, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionInvoice for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptioninvoices." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionInvoice" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog", "description" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_SubscriptionInvoice", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * billing.dueDate * billing.payment.id * billing.payment.dueDate * scopeResource.approval.previousState * scopeResource.state.name * billing.payment.amount.currency * scopeResource.state.when.timestamp * billing.amount.currency * marketplace.resource.owner.organization.id * invoiced.amount.currency * billing.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * billing.payment.issueDate * scopeResource.marketplace.resource.owner.id * spec.period.to * billing.payment.type * billing.customer.id * billing.payment.number * spec.period.from * spec.cost.plan.currency * billing.payment.customer.id * state.name * status.level * billing.issueDate * billing.number * marketplace.resource.owner.id * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.billing.type * billing.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionInvoice for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptioninvoices." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/mcpclients" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves MCPClient for version v1 from group catalog", "description" : "Retrieves MCPClient for version v1 from group catalog", "operationId" : "list_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type MCPClient for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of mcpclients." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of MCPClient for version v1 from group catalog", "description" : "Retrieves a count of MCPClient for version v1 from group catalog", "operationId" : "count_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of MCPClient for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of mcpclients." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create MCPClient for version v1 from group catalog", "description" : "Create MCPClient for version v1 from group catalog", "operationId" : "create_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "201" : { "description" : "Create a new MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/mcpclients/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves MCPClient for version v1 from group catalog", "description" : "Retrieves MCPClient for version v1 from group catalog", "operationId" : "read_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove MCPClient for version v1 from group catalog", "description" : "Remove MCPClient for version v1 from group catalog", "operationId" : "remove_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing MCPClient for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed MCPClient for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update MCPClient for version v1 from group catalog", "description" : "Update MCPClient for version v1 from group catalog", "operationId" : "update_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Update MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch MCPClient for version v1 from group catalog", "description" : "Patch MCPClient for version v1 from group catalog", "operationId" : "patch_catalog_v1_MCPClient", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/mcpclients/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of MCPClient for version v1 from group catalog", "description" : "Retrieves icon resource data of MCPClient for version v1 from group catalog", "operationId" : "read_catalog_v1_MCPClient_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of MCPClient for version v1 from group catalog", "description" : "Update icon resource data of MCPClient for version v1 from group catalog", "operationId" : "update_catalog_v1_MCPClient_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/mcpclients/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of MCPClient for version v1 from group catalog", "description" : "Retrieves Extension resource data of MCPClient for version v1 from group catalog", "operationId" : "read_catalog_v1_MCPClient_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of MCPClient for version v1 from group catalog", "description" : "Update Extension resource data of MCPClient for version v1 from group catalog", "operationId" : "update_catalog_v1_MCPClient_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/mcpclients/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for MCPClient for version v1 from group catalog", "description" : "Retrieves Languages data for MCPClient for version v1 from group catalog", "operationId" : "read_catalog_v1_MCPClient_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for MCPClient for version v1 from group catalog", "description" : "Update Languages data for MCPClient for version v1 from group catalog", "operationId" : "update_catalog_v1_MCPClient_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/mcpclients/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for MCPClient for version v1 from group catalog", "description" : "Retrieves Languages data for MCPClient for version v1 from group catalog", "operationId" : "read_catalog_v1_MCPClient_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for MCPClient for version v1 from group catalog", "description" : "Update Languages data for MCPClient for version v1 from group catalog", "operationId" : "update_catalog_v1_MCPClient_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for MCPClient for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves MCPClient for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type MCPClient for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of mcpclients." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves a count of MCPClient for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of MCPClient for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of mcpclients." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create MCPClient for version v1alpha1 from group catalog", "description" : "Create MCPClient for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "201" : { "description" : "Create a new MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves MCPClient for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove MCPClient for version v1alpha1 from group catalog", "description" : "Remove MCPClient for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing MCPClient for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed MCPClient for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update MCPClient for version v1alpha1 from group catalog", "description" : "Update MCPClient for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Update MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch MCPClient for version v1alpha1 from group catalog", "description" : "Patch MCPClient for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_MCPClient", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of MCPClient for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_MCPClient_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of MCPClient for version v1alpha1 from group catalog", "description" : "Update icon resource data of MCPClient for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_MCPClient_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of MCPClient for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_MCPClient_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of MCPClient for version v1alpha1 from group catalog", "description" : "Update Extension resource data of MCPClient for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_MCPClient_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for MCPClient for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_MCPClient_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for MCPClient for version v1alpha1 from group catalog", "description" : "Update Languages data for MCPClient for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_MCPClient_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for MCPClient for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for MCPClient for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_MCPClient_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for MCPClient for version v1alpha1 from group catalog", "description" : "Update Languages data for MCPClient for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_MCPClient_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.MCPClient resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for MCPClient for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.MCPClient" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentResource for version v1 from group catalog", "description" : "Retrieves DocumentResource for version v1 from group catalog", "operationId" : "list_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.usage.apiServices.available * state.name * spec.version * spec.usage.products.available * spec.data.fileType * references.platformSettings.used * spec.data.fileName * spec.data.type * spec.usage.mcpClients.available * spec.data.contentType * spec.usage.marketplaceSettings.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentResource for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentResource for version v1 from group catalog", "description" : "Retrieves a count of DocumentResource for version v1 from group catalog", "operationId" : "count_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.usage.apiServices.available * state.name * spec.version * spec.usage.products.available * spec.data.fileType * references.platformSettings.used * spec.data.fileName * spec.data.type * spec.usage.mcpClients.available * spec.data.contentType * spec.usage.marketplaceSettings.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentResource for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentResource for version v1 from group catalog", "description" : "Create DocumentResource for version v1 from group catalog", "operationId" : "create_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentResource for version v1 from group catalog", "description" : "Retrieves DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentResource for version v1 from group catalog", "description" : "Remove DocumentResource for version v1 from group catalog", "operationId" : "remove_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentResource for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentResource for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentResource for version v1 from group catalog", "description" : "Update DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Update DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentResource for version v1 from group catalog", "description" : "Patch DocumentResource for version v1 from group catalog", "operationId" : "patch_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/raw" : { "get" : { "summary" : "Retrieves DocumentResource for version v1 from group catalog properties raw data.", "description" : "Retrieves DocumentResource for version v1 from group catalog", "operationId" : "read_raw_catalog_v1_DocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1.DocumentResource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1.DocumentResource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read DocumentResource for version v1 from group catalog raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of DocumentResource for version v1 from group catalog", "description" : "Retrieves icon resource data of DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of DocumentResource for version v1 from group catalog", "description" : "Update icon resource data of DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of DocumentResource for version v1 from group catalog", "description" : "Retrieves state resource data of DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of DocumentResource for version v1 from group catalog", "description" : "Update state resource data of DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of DocumentResource for version v1 from group catalog", "description" : "Retrieves references resource data of DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of DocumentResource for version v1 from group catalog", "description" : "Update references resource data of DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentResource for version v1 from group catalog", "description" : "Retrieves Extension resource data of DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentResource for version v1 from group catalog", "description" : "Update Extension resource data of DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentResource for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentResource for version v1 from group catalog", "description" : "Update Languages data for DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentResource for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentResource for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentResource for version v1 from group catalog", "description" : "Update Languages data for DocumentResource for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentResource for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves DocumentResource for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.usage.apiServices.available * state.name * spec.version * spec.usage.products.available * spec.data.fileType * references.platformSettings.used * spec.data.fileName * spec.data.type * spec.usage.mcpClients.available * spec.data.contentType * spec.usage.marketplaceSettings.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentResource for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves a count of DocumentResource for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.usage.apiServices.available * state.name * spec.version * spec.usage.products.available * spec.data.fileType * references.platformSettings.used * spec.data.fileName * spec.data.type * spec.usage.mcpClients.available * spec.data.contentType * spec.usage.marketplaceSettings.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentResource for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentResource for version v1alpha1 from group catalog", "description" : "Create DocumentResource for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentResource for version v1alpha1 from group catalog", "description" : "Remove DocumentResource for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentResource for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentResource for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentResource for version v1alpha1 from group catalog", "description" : "Update DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Update DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentResource for version v1alpha1 from group catalog", "description" : "Patch DocumentResource for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/raw" : { "get" : { "summary" : "Retrieves DocumentResource for version v1alpha1 from group catalog properties raw data.", "description" : "Retrieves DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_raw_catalog_v1alpha1_DocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1alpha1.DocumentResource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1alpha1.DocumentResource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read DocumentResource for version v1alpha1 from group catalog raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Update references resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Update icon resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Update state resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentResource for version v1alpha1 from group catalog", "description" : "Update Extension resource data of DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentResource for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentResource for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentResource_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentResource for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentResource for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentResource_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentResource for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentTemplate for version v1 from group catalog", "description" : "Retrieves DocumentTemplate for version v1 from group catalog", "operationId" : "list_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.version * spec.usage.useAsDefault * spec.usage.enforced\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentTemplate for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documenttemplates." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentTemplate for version v1 from group catalog", "description" : "Retrieves a count of DocumentTemplate for version v1 from group catalog", "operationId" : "count_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.version * spec.usage.useAsDefault * spec.usage.enforced\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentTemplate for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documenttemplates." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentTemplate for version v1 from group catalog", "description" : "Create DocumentTemplate for version v1 from group catalog", "operationId" : "create_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentTemplate for version v1 from group catalog", "description" : "Retrieves DocumentTemplate for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentTemplate for version v1 from group catalog", "description" : "Remove DocumentTemplate for version v1 from group catalog", "operationId" : "remove_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentTemplate for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentTemplate for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentTemplate for version v1 from group catalog", "description" : "Update DocumentTemplate for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Update DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentTemplate for version v1 from group catalog", "description" : "Patch DocumentTemplate for version v1 from group catalog", "operationId" : "patch_catalog_v1_DocumentTemplate", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentTemplate for version v1 from group catalog", "description" : "Retrieves Extension resource data of DocumentTemplate for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentTemplate_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentTemplate for version v1 from group catalog", "description" : "Update Extension resource data of DocumentTemplate for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentTemplate_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentTemplate for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentTemplate for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentTemplate_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentTemplate for version v1 from group catalog", "description" : "Update Languages data for DocumentTemplate for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentTemplate_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentTemplate for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentTemplate for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentTemplate_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentTemplate for version v1 from group catalog", "description" : "Update Languages data for DocumentTemplate for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentTemplate_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentTemplate for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.version * spec.usage.useAsDefault * spec.usage.enforced\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentTemplate for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documenttemplates." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves a count of DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.version * spec.usage.useAsDefault * spec.usage.enforced\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentTemplate for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documenttemplates." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentTemplate for version v1alpha1 from group catalog", "description" : "Create DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentTemplate for version v1alpha1 from group catalog", "description" : "Remove DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentTemplate for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentTemplate for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentTemplate for version v1alpha1 from group catalog", "description" : "Update DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Update DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentTemplate for version v1alpha1 from group catalog", "description" : "Patch DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_DocumentTemplate", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "description" : "Update Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentTemplate for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentTemplate for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentTemplate for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentTemplate for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentTemplate for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentCollection for version v1 from group catalog", "description" : "Retrieves DocumentCollection for version v1 from group catalog", "operationId" : "list_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.usage.kind\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentCollection for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentcollections." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentCollection for version v1 from group catalog", "description" : "Retrieves a count of DocumentCollection for version v1 from group catalog", "operationId" : "count_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.usage.kind\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentCollection for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentcollections." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentCollection for version v1 from group catalog", "description" : "Create DocumentCollection for version v1 from group catalog", "operationId" : "create_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentCollection for version v1 from group catalog", "description" : "Retrieves DocumentCollection for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentCollection for version v1 from group catalog", "description" : "Remove DocumentCollection for version v1 from group catalog", "operationId" : "remove_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentCollection for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentCollection for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentCollection for version v1 from group catalog", "description" : "Update DocumentCollection for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Update DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentCollection for version v1 from group catalog", "description" : "Patch DocumentCollection for version v1 from group catalog", "operationId" : "patch_catalog_v1_DocumentCollection", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentCollection for version v1 from group catalog", "description" : "Retrieves Extension resource data of DocumentCollection for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentCollection_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentCollection for version v1 from group catalog", "description" : "Update Extension resource data of DocumentCollection for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentCollection_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentCollection for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentCollection for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentCollection_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentCollection for version v1 from group catalog", "description" : "Update Languages data for DocumentCollection for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentCollection_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentCollection for version v1 from group catalog", "description" : "Retrieves Languages data for DocumentCollection for version v1 from group catalog", "operationId" : "read_catalog_v1_DocumentCollection_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentCollection for version v1 from group catalog", "description" : "Update Languages data for DocumentCollection for version v1 from group catalog", "operationId" : "update_catalog_v1_DocumentCollection_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentCollection for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves DocumentCollection for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.usage.kind\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type DocumentCollection for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentcollections." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves a count of DocumentCollection for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.usage.kind\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of DocumentCollection for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documentcollections." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create DocumentCollection for version v1alpha1 from group catalog", "description" : "Create DocumentCollection for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "responses" : { "201" : { "description" : "Create a new DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves DocumentCollection for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove DocumentCollection for version v1alpha1 from group catalog", "description" : "Remove DocumentCollection for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing DocumentCollection for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed DocumentCollection for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update DocumentCollection for version v1alpha1 from group catalog", "description" : "Update DocumentCollection for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Update DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch DocumentCollection for version v1alpha1 from group catalog", "description" : "Patch DocumentCollection for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_DocumentCollection", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentCollection_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "description" : "Update Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentCollection_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentCollection for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentCollection_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentCollection for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentCollection for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentCollection_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for DocumentCollection for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for DocumentCollection for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_DocumentCollection_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for DocumentCollection for version v1alpha1 from group catalog", "description" : "Update Languages data for DocumentCollection for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_DocumentCollection_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.DocumentCollection resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for DocumentCollection for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.DocumentCollection" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Create ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Remove ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Update ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Patch ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/references" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Update references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1_AuthorizationProfile_ApplicationProfileDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applicationprofiledefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group catalog", "operationId" : "list_catalog_v1_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog", "operationId" : "count_catalog_v1_ApplicationProfileDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/references" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/applicationprofiledefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_ApplicationProfileDefinition_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applicationprofiledefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "list_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfile for version v1 from group catalog in scope Application", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves a count of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "count_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfile for version v1 from group catalog in scope Application.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Create ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "create_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Remove ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "remove_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfile for version v1 from group catalog in scope Application. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfile for version v1 from group catalog in scope Application" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Patch ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "patch_catalog_v1_Application_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/marketplace" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/references" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/status" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/{extension}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/languages" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applications/{applicationName}/applicationprofiles/{name}/languages-{code}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Retrieves Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "read_catalog_v1_Application_ApplicationProfile_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "description" : "Update Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "operationId" : "update_catalog_v1_Application_ApplicationProfile_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfile for version v1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/applicationprofiles" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1 from group catalog", "description" : "Retrieves ApplicationProfile for version v1 from group catalog", "operationId" : "list_catalog_v1_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfile for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfile for version v1 from group catalog", "description" : "Retrieves a count of ApplicationProfile for version v1 from group catalog", "operationId" : "count_catalog_v1_ApplicationProfile", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfile for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "list_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfile for version v1alpha1 from group catalog in scope Application", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "count_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog in scope Application.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Create ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "create_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Remove ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "remove_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfile for version v1alpha1 from group catalog in scope Application. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfile for version v1alpha1 from group catalog in scope Application" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Patch ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "patch_catalog_v1alpha1_Application_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/marketplace" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/references" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/status" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/{extension}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/languages" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/applicationprofiles/{name}/languages-{code}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_ApplicationProfile_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_ApplicationProfile_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfile for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applicationprofiles" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog", "description" : "Retrieves ApplicationProfile for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfile for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog", "description" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ApplicationProfile", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfile for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Environment for version v1alpha1 from group management", "description" : "Retrieves Environment for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, stages, compliancetasks, policies, traceable, sampletrigger, complianceruntimeresult, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Environment for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of environments." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Environment for version v1alpha1 from group management", "description" : "Retrieves a count of Environment for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Environment for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of environments." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Environment for version v1alpha1 from group management", "description" : "Create Environment for version v1alpha1 from group management", "operationId" : "create_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, stages, compliancetasks, policies, traceable, sampletrigger, complianceruntimeresult, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "201" : { "description" : "Create a new Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Environment for version v1alpha1 from group management", "description" : "Retrieves Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, stages, compliancetasks, policies, traceable, sampletrigger, complianceruntimeresult, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Environment for version v1alpha1 from group management", "description" : "Remove Environment for version v1alpha1 from group management", "operationId" : "remove_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Environment for version v1alpha1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Environment for version v1alpha1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Environment for version v1alpha1 from group management", "description" : "Update Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, stages, compliancetasks, policies, traceable, sampletrigger, complianceruntimeresult, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Update Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Environment for version v1alpha1 from group management", "description" : "Patch Environment for version v1alpha1 from group management", "operationId" : "patch_management_v1alpha1_Environment", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, stages, compliancetasks, policies, traceable, sampletrigger, complianceruntimeresult, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/stages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves stages resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves stages resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_stages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read stages resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update stages resource data of Environment for version v1alpha1 from group management", "description" : "Update stages resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_stages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated stages resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/compliancetasks" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves compliancetasks resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves compliancetasks resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_compliancetasks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read compliancetasks resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update compliancetasks resource data of Environment for version v1alpha1 from group management", "description" : "Update compliancetasks resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_compliancetasks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated compliancetasks resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/policies" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves policies resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves policies resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_policies", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read policies resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update policies resource data of Environment for version v1alpha1 from group management", "description" : "Update policies resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_policies", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated policies resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/traceable" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves traceable resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves traceable resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_traceable", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read traceable resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update traceable resource data of Environment for version v1alpha1 from group management", "description" : "Update traceable resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_traceable", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated traceable resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/sampletrigger" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves sampletrigger resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves sampletrigger resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read sampletrigger resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update sampletrigger resource data of Environment for version v1alpha1 from group management", "description" : "Update sampletrigger resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated sampletrigger resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/complianceruntimeresult" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "description" : "Update complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated complianceruntimeresult resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves references resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Environment for version v1alpha1 from group management", "description" : "Update references resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Environment for version v1alpha1 from group management", "description" : "Retrieves Extension resource data of Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Environment for version v1alpha1 from group management", "description" : "Update Extension resource data of Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Environment for version v1alpha1 from group management", "description" : "Retrieves Languages data for Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Environment for version v1alpha1 from group management", "description" : "Update Languages data for Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Environment for version v1alpha1 from group management", "description" : "Retrieves Languages data for Environment for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Environment_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Environment for version v1alpha1 from group management", "description" : "Update Languages data for Environment for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Environment_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Environment resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Environment for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Environment" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIService for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * compliance.state * source.dataplaneType.design * compliance.runtime.result.grade * details.specType * compliance.design.state * source.dataplaneType.managed * agentdetails.syncWarning * profile.dataClassification * compliance.result.grade * agentdetails.remoteAPIID * compliance.design.result.grade * compliance.security.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIService for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservices." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * compliance.state * source.dataplaneType.design * compliance.runtime.result.grade * details.specType * compliance.design.state * source.dataplaneType.managed * agentdetails.syncWarning * profile.dataClassification * compliance.result.grade * agentdetails.remoteAPIID * compliance.design.result.grade * compliance.security.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIService for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservices." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APIService for version v1alpha1 from group management in scope Environment", "description" : "Create APIService for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "201" : { "description" : "Create a new APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APIService for version v1alpha1 from group management in scope Environment", "description" : "Remove APIService for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APIService for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APIService for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APIService for version v1alpha1 from group management in scope Environment", "description" : "Update APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Update APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APIService for version v1alpha1 from group management in scope Environment", "description" : "Patch APIService for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/details" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves details resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves details resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_details", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read details resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update details resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update details resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_details", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated details resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/agentdetails" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_agentdetails", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_agentdetails", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated agentdetails resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/compliance" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated compliance resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/sampletrigger" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated sampletrigger resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/samplestate" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_samplestate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_samplestate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated samplestate resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/complianceruntimeresult" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated complianceruntimeresult resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/appinfo" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_appinfo", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_appinfo", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated appinfo resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/profile" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves profile resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves profile resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_profile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read profile resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update profile resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update profile resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_profile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated profile resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/source" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves source resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves source resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_source", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read source resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update source resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update source resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_source", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated source resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIService for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservices/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APIService", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIService for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIService for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIService_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIService for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIService for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIService_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIService for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apiservices" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIService for version v1alpha1 from group management", "description" : "Retrieves APIService for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_APIService", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * compliance.state * source.dataplaneType.design * compliance.runtime.result.grade * details.specType * compliance.design.state * source.dataplaneType.managed * agentdetails.syncWarning * profile.dataClassification * compliance.result.grade * agentdetails.remoteAPIID * compliance.design.result.grade * compliance.security.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIService resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, details, agentdetails, compliance, sampletrigger, samplestate, complianceruntimeresult, appinfo, profile, references, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIService for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservices." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIService" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIService for version v1alpha1 from group management", "description" : "Retrieves a count of APIService for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_APIService", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * compliance.state * source.dataplaneType.design * compliance.runtime.result.grade * details.specType * compliance.design.state * source.dataplaneType.managed * agentdetails.syncWarning * profile.dataClassification * compliance.result.grade * agentdetails.remoteAPIID * compliance.design.result.grade * compliance.security.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIService for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservices." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.definition.type * compliance.result.grade * spec.definition.version * compliance.state * compliance.design.result.grade * compliance.security.state * compliance.design.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIServiceRevision for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservicerevisions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.definition.type * compliance.result.grade * spec.definition.version * compliance.state * compliance.design.result.grade * compliance.security.state * compliance.design.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservicerevisions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Create APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "201" : { "description" : "Create a new APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceRevision", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Remove APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APIServiceRevision for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APIServiceRevision for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Update APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "200" : { "description" : "Update APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Patch APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions/{name}/compliance" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceRevision", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceRevision_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Update compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceRevision_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "200" : { "description" : "Updated compliance resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceRevision", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceRevision_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceRevision_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceRevision", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceRevision_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceRevision_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiservicerevisions/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceRevision", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceRevision_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceRevision_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIServiceRevision for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apiservicerevisions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceRevision for version v1alpha1 from group management", "description" : "Retrieves APIServiceRevision for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.definition.type * compliance.result.grade * spec.definition.version * compliance.state * compliance.design.result.grade * compliance.security.state * compliance.design.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceRevision resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, compliance, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIServiceRevision for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservicerevisions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceRevision" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management", "description" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_APIServiceRevision", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.definition.type * compliance.result.grade * spec.definition.version * compliance.state * compliance.design.result.grade * compliance.security.state * compliance.design.state * compliance.security.result.grade * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIServiceRevision for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiservicerevisions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * compliance.result.grade * spec.mock.name * lifecycle.releaseState.name * lifecycle.stage * source.dataplaneType.design * compliance.runtime.result.grade * source.dataplaneType.managed * scopeResource.spec.axwayManaged * spec.mock.useLatestRevision.apiService\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIServiceInstance for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiserviceinstances." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * compliance.result.grade * spec.mock.name * lifecycle.releaseState.name * lifecycle.stage * source.dataplaneType.design * compliance.runtime.result.grade * source.dataplaneType.managed * scopeResource.spec.axwayManaged * spec.mock.useLatestRevision.apiService\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiserviceinstances." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Create APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "201" : { "description" : "Create a new APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Remove APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APIServiceInstance for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APIServiceInstance for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Update APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Patch APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/lifecycle" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_lifecycle", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_lifecycle", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated lifecycle resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/compliance" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_compliance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated compliance resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/traceable" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_traceable", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_traceable", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated traceable resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/sampletrigger" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_sampletrigger", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated sampletrigger resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/samplestate" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_samplestate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_samplestate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated samplestate resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/complianceruntimeresult" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_complianceruntimeresult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated complianceruntimeresult resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/source" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_source", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_source", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated source resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apiserviceinstances/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APIServiceInstance", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APIServiceInstance_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APIServiceInstance_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APIServiceInstance for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apiserviceinstances" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APIServiceInstance for version v1alpha1 from group management", "description" : "Retrieves APIServiceInstance for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * compliance.result.grade * spec.mock.name * lifecycle.releaseState.name * lifecycle.stage * source.dataplaneType.design * compliance.runtime.result.grade * source.dataplaneType.managed * scopeResource.spec.axwayManaged * spec.mock.useLatestRevision.apiService\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APIServiceInstance resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, lifecycle, references, compliance, traceable, sampletrigger, samplestate, complianceruntimeresult, source, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APIServiceInstance for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiserviceinstances." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APIServiceInstance" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management", "description" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_APIServiceInstance", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * compliance.result.grade * spec.mock.name * lifecycle.releaseState.name * lifecycle.stage * source.dataplaneType.design * compliance.runtime.result.grade * source.dataplaneType.managed * scopeResource.spec.axwayManaged * spec.mock.useLatestRevision.apiService\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APIServiceInstance for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apiserviceinstances." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "list_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingJob for version v1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves a count of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "count_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingJob for version v1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Create APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "create_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "201" : { "description" : "Create a new APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Remove APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "remove_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APISpecLintingJob for version v1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APISpecLintingJob for version v1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Patch APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "patch_management_v1_Environment_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/archived" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_archived", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_archived", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated archived resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/result" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_result", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_result", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated result resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/state" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/apispeclintingjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_APISpecLintingJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "description" : "Update Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_APISpecLintingJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1 from group management", "description" : "Retrieves APISpecLintingJob for version v1 from group management", "operationId" : "list_management_v1_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, archived, result, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingJob for version v1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingJob for version v1 from group management", "description" : "Retrieves a count of APISpecLintingJob for version v1 from group management", "operationId" : "count_management_v1_APISpecLintingJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingJob for version v1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingJob for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Create APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "201" : { "description" : "Create a new APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Remove APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APISpecLintingJob for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APISpecLintingJob for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Patch APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/result" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_result", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_result", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated result resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/archived" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_archived", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_archived", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated archived resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/state" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_state", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_state", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/apispeclintingjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_APISpecLintingJob_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_APISpecLintingJob_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingJob for version v1alpha1 from group management", "description" : "Retrieves APISpecLintingJob for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, result, archived, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingJob for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management", "description" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_APISpecLintingJob", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * archived * result.detailsThresholdExceeded * state.name * result.summary * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingJob for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1/apispeclintingrulesets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves APISpecLintingRuleset for version v1 from group management", "operationId" : "list_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.definition.lintingType\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingRuleset for version v1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingrulesets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves a count of APISpecLintingRuleset for version v1 from group management", "operationId" : "count_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.definition.lintingType\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingRuleset for version v1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingrulesets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APISpecLintingRuleset for version v1 from group management", "description" : "Create APISpecLintingRuleset for version v1 from group management", "operationId" : "create_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "201" : { "description" : "Create a new APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingrulesets/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves APISpecLintingRuleset for version v1 from group management", "operationId" : "read_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APISpecLintingRuleset for version v1 from group management", "description" : "Remove APISpecLintingRuleset for version v1 from group management", "operationId" : "remove_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APISpecLintingRuleset for version v1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APISpecLintingRuleset for version v1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APISpecLintingRuleset for version v1 from group management", "description" : "Update APISpecLintingRuleset for version v1 from group management", "operationId" : "update_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APISpecLintingRuleset for version v1 from group management", "description" : "Patch APISpecLintingRuleset for version v1 from group management", "operationId" : "patch_management_v1_APISpecLintingRuleset", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingrulesets/{name}/revision" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves revision resource data of APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves revision resource data of APISpecLintingRuleset for version v1 from group management", "operationId" : "read_management_v1_APISpecLintingRuleset_revision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read revision resource data of APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update revision resource data of APISpecLintingRuleset for version v1 from group management", "description" : "Update revision resource data of APISpecLintingRuleset for version v1 from group management", "operationId" : "update_management_v1_APISpecLintingRuleset_revision", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated revision resource data of APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingrulesets/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves Extension resource data of APISpecLintingRuleset for version v1 from group management", "operationId" : "read_management_v1_APISpecLintingRuleset_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APISpecLintingRuleset for version v1 from group management", "description" : "Update Extension resource data of APISpecLintingRuleset for version v1 from group management", "operationId" : "update_management_v1_APISpecLintingRuleset_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingrulesets/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves Languages data for APISpecLintingRuleset for version v1 from group management", "operationId" : "read_management_v1_APISpecLintingRuleset_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingRuleset for version v1 from group management", "description" : "Update Languages data for APISpecLintingRuleset for version v1 from group management", "operationId" : "update_management_v1_APISpecLintingRuleset_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/apispeclintingrulesets/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingRuleset for version v1 from group management", "description" : "Retrieves Languages data for APISpecLintingRuleset for version v1 from group management", "operationId" : "read_management_v1_APISpecLintingRuleset_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingRuleset for version v1 from group management", "description" : "Update Languages data for APISpecLintingRuleset for version v1 from group management", "operationId" : "update_management_v1_APISpecLintingRuleset_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingRuleset for version v1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.definition.lintingType\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type APISpecLintingRuleset for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingrulesets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves a count of APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.definition.lintingType\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of APISpecLintingRuleset for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of apispeclintingrulesets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Create APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "create_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "201" : { "description" : "Create a new APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Remove APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "remove_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing APISpecLintingRuleset for version v1alpha1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed APISpecLintingRuleset for version v1alpha1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Update APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Patch APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "patch_management_v1alpha1_APISpecLintingRuleset", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, revision, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{name}/revision" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_revision", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Update revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_revision", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated revision resource data of APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Update Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Update Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Retrieves Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "description" : "Update Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.APISpecLintingRuleset resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for APISpecLintingRuleset for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.APISpecLintingRuleset" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Integration for version v1alpha1 from group management", "description" : "Retrieves Integration for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Integration for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of integrations." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Integration for version v1alpha1 from group management", "description" : "Retrieves a count of Integration for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Integration for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of integrations." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Integration for version v1alpha1 from group management", "description" : "Create Integration for version v1alpha1 from group management", "operationId" : "create_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "responses" : { "201" : { "description" : "Create a new Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Integration for version v1alpha1 from group management", "description" : "Retrieves Integration for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Integration for version v1alpha1 from group management", "description" : "Remove Integration for version v1alpha1 from group management", "operationId" : "remove_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Integration for version v1alpha1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Integration for version v1alpha1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Integration for version v1alpha1 from group management", "description" : "Update Integration for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "responses" : { "200" : { "description" : "Update Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Integration for version v1alpha1 from group management", "description" : "Patch Integration for version v1alpha1 from group management", "operationId" : "patch_management_v1alpha1_Integration", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Integration for version v1alpha1 from group management", "description" : "Retrieves Extension resource data of Integration for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Integration_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Integration for version v1alpha1 from group management", "description" : "Update Extension resource data of Integration for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Integration_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Integration for version v1alpha1 from group management", "description" : "Retrieves Languages data for Integration for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Integration_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Integration for version v1alpha1 from group management", "description" : "Update Languages data for Integration for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Integration_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Integration for version v1alpha1 from group management", "description" : "Retrieves Languages data for Integration for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_Integration_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Integration for version v1alpha1 from group management", "description" : "Update Languages data for Integration for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_Integration_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Integration resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Integration for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Integration" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/resourcehooks" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "list_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceHook for version v1alpha1 from group management in scope Integration", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourcehooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves a count of ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "count_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceHook for version v1alpha1 from group management in scope Integration.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourcehooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Create ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "create_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "responses" : { "201" : { "description" : "Create a new ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/resourcehooks/{name}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceHook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Remove ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "remove_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ResourceHook for version v1alpha1 from group management in scope Integration. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ResourceHook for version v1alpha1 from group management in scope Integration" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Update ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "responses" : { "200" : { "description" : "Update ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Patch ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "patch_management_v1alpha1_Integration_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/resourcehooks/{name}/{extension}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceHook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_ResourceHook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Update Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_ResourceHook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/resourcehooks/{name}/languages" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceHook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_ResourceHook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_ResourceHook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/resourcehooks/{name}/languages-{code}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceHook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_ResourceHook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_ResourceHook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceHook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/resourcehooks" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceHook for version v1alpha1 from group management", "description" : "Retrieves ResourceHook for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ResourceHook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceHook for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourcehooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ResourceHook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceHook for version v1alpha1 from group management", "description" : "Retrieves a count of ResourceHook for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ResourceHook", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceHook for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourcehooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappingtemplates" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappingtemplates." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappingtemplates." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Create AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "responses" : { "201" : { "description" : "Create a new AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappingtemplates/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMappingTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Remove AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetMappingTemplate for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetMappingTemplate for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Update AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "responses" : { "200" : { "description" : "Update AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Patch AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappingtemplates/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMappingTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMappingTemplate_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMappingTemplate_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappingtemplates/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMappingTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMappingTemplate_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMappingTemplate_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappingtemplates/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMappingTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMappingTemplate_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMappingTemplate_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMappingTemplate for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/assetmappingtemplates" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management", "description" : "Retrieves AssetMappingTemplate for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMappingTemplate resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMappingTemplate for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappingtemplates." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMappingTemplate" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management", "description" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_AssetMappingTemplate", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMappingTemplate for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappingtemplates." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Create AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Remove AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessRequestDefinition for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessRequestDefinition for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Patch AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}/webhooks" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition_webhooks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition_webhooks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated webhooks resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}/applicationprofile" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition_applicationprofile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition_applicationprofile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated applicationprofile resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequestDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequestDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/accessrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management", "description" : "Retrieves AccessRequestDefinition for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, applicationprofile, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessRequestDefinition for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management", "description" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_AccessRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessRequestDefinition for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessRequest for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequests." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessRequest for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequests." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Create AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "201" : { "description" : "Create a new AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Remove AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessRequest for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessRequest for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Update AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Patch AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/data" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_data", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_data", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated data resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accessrequests/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessRequest_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessRequest_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessRequest for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/accessrequests" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessRequest for version v1alpha1 from group management", "description" : "Retrieves AccessRequest for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, data, status, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessRequest for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequests." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessRequest" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessRequest for version v1alpha1 from group management", "description" : "Retrieves a count of AccessRequest for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_AccessRequest", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessRequest for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accessrequests." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * marketplace.resource.owner.id * marketplace.resource.owner.organization.id * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplication for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplications." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * marketplace.resource.owner.id * marketplace.resource.owner.organization.id * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplications." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Create ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "201" : { "description" : "Create a new ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Remove ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ManagedApplication for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ManagedApplication for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Patch ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/marketplace" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_marketplace", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_marketplace", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplications/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplication", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplication_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplication_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplication for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/managedapplications" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplication for version v1alpha1 from group management", "description" : "Retrieves ManagedApplication for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * marketplace.resource.owner.id * marketplace.resource.owner.organization.id * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplication resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplication for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplications." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplication" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management", "description" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ManagedApplication", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * marketplace.resource.owner.id * marketplace.resource.owner.organization.id * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplication for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplications." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Create CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Remove CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing CredentialRequestDefinition for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed CredentialRequestDefinition for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Patch CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions/{name}/webhooks" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_CredentialRequestDefinition_webhooks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_CredentialRequestDefinition_webhooks", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated webhooks resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_CredentialRequestDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_CredentialRequestDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_CredentialRequestDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_CredentialRequestDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentialrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the CredentialRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_CredentialRequestDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_CredentialRequestDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CredentialRequestDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/credentialrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management", "description" : "Retrieves CredentialRequestDefinition for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.CredentialRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CredentialRequestDefinition for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.CredentialRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management", "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_CredentialRequestDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CredentialRequestDefinition for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentialrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/credentials" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Credential for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * status.level * spec.state.name * policies.expiry.timestamp * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Credential for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * status.level * spec.state.name * policies.expiry.timestamp * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Credential for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Credential for version v1alpha1 from group management in scope Environment", "description" : "Create Credential for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "201" : { "description" : "Create a new Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Credential for version v1alpha1 from group management in scope Environment", "description" : "Remove Credential for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Credential for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Credential for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Credential for version v1alpha1 from group management in scope Environment", "description" : "Update Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Update Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Credential for version v1alpha1 from group management in scope Environment", "description" : "Patch Credential for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/data" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves data resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves data resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_data", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read data resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update data resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update data resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_data", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated data resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/state" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves state resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update state resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_state", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/policies" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves policies resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves policies resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_policies", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read policies resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update policies resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update policies resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_policies", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated policies resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Credential for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/credentials/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Credential", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Credential for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Credential for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Credential_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Credential for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Credential for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Credential_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Credential for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/credentials" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Credential for version v1alpha1 from group management", "description" : "Retrieves Credential for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Credential", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * status.level * spec.state.name * policies.expiry.timestamp * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Credential resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, data, state, policies, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Credential for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Credential" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Credential for version v1alpha1 from group management", "description" : "Retrieves a count of Credential for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Credential", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * status.level * spec.state.name * policies.expiry.timestamp * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Credential for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of credentials." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/identityproviders" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves IdentityProvider for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, security, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type IdentityProvider for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of identityproviders." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves a count of IdentityProvider for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of IdentityProvider for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of identityproviders." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create IdentityProvider for version v1alpha1 from group management", "description" : "Create IdentityProvider for version v1alpha1 from group management", "operationId" : "create_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, security, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "201" : { "description" : "Create a new IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, security, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove IdentityProvider for version v1alpha1 from group management", "description" : "Remove IdentityProvider for version v1alpha1 from group management", "operationId" : "remove_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing IdentityProvider for version v1alpha1 from group management. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed IdentityProvider for version v1alpha1 from group management" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update IdentityProvider for version v1alpha1 from group management", "description" : "Update IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, security, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Update IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch IdentityProvider for version v1alpha1 from group management", "description" : "Patch IdentityProvider for version v1alpha1 from group management", "operationId" : "patch_management_v1alpha1_IdentityProvider", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, security, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}/security" : { "parameters" : [ { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves security resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves security resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider_security", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read security resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update security resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Update security resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider_security", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Updated security resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves status resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Update status resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves Extension resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of IdentityProvider for version v1alpha1 from group management", "description" : "Update Extension resource data of IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves Languages data for IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for IdentityProvider for version v1alpha1 from group management", "description" : "Update Languages data for IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for IdentityProvider for version v1alpha1 from group management", "description" : "Retrieves Languages data for IdentityProvider for version v1alpha1 from group management", "operationId" : "read_management_v1alpha1_IdentityProvider_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for IdentityProvider for version v1alpha1 from group management", "description" : "Update Languages data for IdentityProvider for version v1alpha1 from group management", "operationId" : "update_management_v1alpha1_IdentityProvider_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProvider resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for IdentityProvider for version v1alpha1 from group management", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProvider" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/idpsecrets" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "list_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of idpsecrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "count_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of idpsecrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Create IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "create_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "responses" : { "201" : { "description" : "Create a new IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/idpsecrets/{name}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProviderSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Remove IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "remove_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "responses" : { "200" : { "description" : "Update IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Patch IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "patch_management_v1alpha1_IdentityProvider_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/idpsecrets/{name}/{extension}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProviderSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_IdentityProviderSecret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_IdentityProviderSecret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/idpsecrets/{name}/languages" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProviderSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_IdentityProviderSecret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_IdentityProviderSecret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/idpsecrets/{name}/languages-{code}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the IdentityProviderSecret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_IdentityProviderSecret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_IdentityProviderSecret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for IdentityProviderSecret for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/idpsecrets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management", "description" : "Retrieves IdentityProviderSecret for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.IdentityProviderSecret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type IdentityProviderSecret for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of idpsecrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.IdentityProviderSecret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management", "description" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_IdentityProviderSecret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of IdentityProviderSecret for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of idpsecrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1/environments/{environmentName}/applicationprofiledefinitions" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "list_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "count_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Create ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "create_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/applicationprofiledefinitions/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Remove ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "remove_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfileDefinition for version v1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfileDefinition for version v1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Update ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Patch ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "patch_management_v1_Environment_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/applicationprofiledefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ApplicationProfileDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Update Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ApplicationProfileDefinition_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/applicationprofiledefinitions/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ApplicationProfileDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Update Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ApplicationProfileDefinition_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/applicationprofiledefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ApplicationProfileDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "description" : "Update Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ApplicationProfileDefinition_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/applicationprofiledefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1 from group management", "description" : "Retrieves ApplicationProfileDefinition for version v1 from group management", "operationId" : "list_management_v1_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management", "operationId" : "count_management_v1_ApplicationProfileDefinition", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/applicationprofiledefinitions" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Create ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/applicationprofiledefinitions/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Remove ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Patch ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/applicationprofiledefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ApplicationProfileDefinition_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ApplicationProfileDefinition_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/applicationprofiledefinitions/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ApplicationProfileDefinition_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ApplicationProfileDefinition_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/applicationprofiledefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ApplicationProfileDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ApplicationProfileDefinition_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ApplicationProfileDefinition_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ApplicationProfileDefinition for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/applicationprofiledefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management", "description" : "Retrieves ApplicationProfileDefinition for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ApplicationProfileDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ApplicationProfileDefinition for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ApplicationProfileDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management", "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ApplicationProfileDefinition", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ApplicationProfileDefinition for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of applicationprofiledefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "list_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplicationProfile for version v1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "count_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Create ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "create_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "201" : { "description" : "Create a new ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Remove ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "remove_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ManagedApplicationProfile for version v1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ManagedApplicationProfile for version v1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Patch ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "patch_management_v1_Environment_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile_references", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/managedapplicationprofiles/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_ManagedApplicationProfile_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_ManagedApplicationProfile_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplicationProfile for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/managedapplicationprofiles" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1 from group management", "description" : "Retrieves ManagedApplicationProfile for version v1 from group management", "operationId" : "list_management_v1_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplicationProfile for version v1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.ManagedApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management", "description" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management", "operationId" : "count_management_v1_ManagedApplicationProfile", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplicationProfile for version v1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Create ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "201" : { "description" : "Create a new ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Remove ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ManagedApplicationProfile for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ManagedApplicationProfile for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Patch ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}/references" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile_references", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile_references", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile_status", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile_status", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile_extension", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile_languages", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/managedapplicationprofiles/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ManagedApplicationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ManagedApplicationProfile_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ManagedApplicationProfile_languages_code", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ManagedApplicationProfile for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/managedapplicationprofiles" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management", "description" : "Retrieves ManagedApplicationProfile for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ManagedApplicationProfile resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ManagedApplicationProfile for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ManagedApplicationProfile" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management", "description" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ManagedApplicationProfile", "deprecated" : true, "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ManagedApplicationProfile for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of managedapplicationprofiles." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/complianceruntimeresults" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.type * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceruntimeresults." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.type * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceruntimeresults." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Create ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "responses" : { "201" : { "description" : "Create a new ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceruntimeresults/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceRuntimeResult", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Remove ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Update ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "responses" : { "200" : { "description" : "Update ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Patch ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceruntimeresults/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceRuntimeResult", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceRuntimeResult_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceRuntimeResult_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceruntimeresults/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceRuntimeResult", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceRuntimeResult_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceRuntimeResult_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/complianceruntimeresults/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ComplianceRuntimeResult", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_ComplianceRuntimeResult_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_ComplianceRuntimeResult_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ComplianceRuntimeResult for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/complianceruntimeresults" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management", "description" : "Retrieves ComplianceRuntimeResult for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.type * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.ComplianceRuntimeResult resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ComplianceRuntimeResult for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceruntimeresults." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.ComplianceRuntimeResult" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management", "description" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_ComplianceRuntimeResult", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.type * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ComplianceRuntimeResult for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of complianceruntimeresults." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/marketplaces" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Marketplace for version v1 from group catalog", "description" : "Retrieves Marketplace for version v1 from group catalog", "operationId" : "list_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Marketplace for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of marketplaces." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Marketplace for version v1 from group catalog", "description" : "Retrieves a count of Marketplace for version v1 from group catalog", "operationId" : "count_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Marketplace for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of marketplaces." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Marketplace for version v1 from group catalog", "description" : "Create Marketplace for version v1 from group catalog", "operationId" : "create_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "201" : { "description" : "Create a new Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Marketplace for version v1 from group catalog", "description" : "Retrieves Marketplace for version v1 from group catalog", "operationId" : "read_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Marketplace for version v1 from group catalog", "description" : "Remove Marketplace for version v1 from group catalog", "operationId" : "remove_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Marketplace for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Marketplace for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Marketplace for version v1 from group catalog", "description" : "Update Marketplace for version v1 from group catalog", "operationId" : "update_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Update Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Marketplace for version v1 from group catalog", "description" : "Patch Marketplace for version v1 from group catalog", "operationId" : "patch_catalog_v1_Marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{name}/billing" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves billing resource data of Marketplace for version v1 from group catalog", "description" : "Retrieves billing resource data of Marketplace for version v1 from group catalog", "operationId" : "read_catalog_v1_Marketplace_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read billing resource data of Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update billing resource data of Marketplace for version v1 from group catalog", "description" : "Update billing resource data of Marketplace for version v1 from group catalog", "operationId" : "update_catalog_v1_Marketplace_billing", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated billing resource data of Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Marketplace for version v1 from group catalog", "description" : "Retrieves Extension resource data of Marketplace for version v1 from group catalog", "operationId" : "read_catalog_v1_Marketplace_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Marketplace for version v1 from group catalog", "description" : "Update Extension resource data of Marketplace for version v1 from group catalog", "operationId" : "update_catalog_v1_Marketplace_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Marketplace for version v1 from group catalog", "description" : "Retrieves Languages data for Marketplace for version v1 from group catalog", "operationId" : "read_catalog_v1_Marketplace_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Marketplace for version v1 from group catalog", "description" : "Update Languages data for Marketplace for version v1 from group catalog", "operationId" : "update_catalog_v1_Marketplace_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Marketplace for version v1 from group catalog", "description" : "Retrieves Languages data for Marketplace for version v1 from group catalog", "operationId" : "read_catalog_v1_Marketplace_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Marketplace for version v1 from group catalog", "description" : "Update Languages data for Marketplace for version v1 from group catalog", "operationId" : "update_catalog_v1_Marketplace_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Marketplace for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves Marketplace for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Marketplace for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of marketplaces." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves a count of Marketplace for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Marketplace for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of marketplaces." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Marketplace for version v1alpha1 from group catalog", "description" : "Create Marketplace for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "201" : { "description" : "Create a new Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves Marketplace for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Marketplace for version v1alpha1 from group catalog", "description" : "Remove Marketplace for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Marketplace for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Marketplace for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Marketplace for version v1alpha1 from group catalog", "description" : "Update Marketplace for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Update Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Marketplace for version v1alpha1 from group catalog", "description" : "Patch Marketplace for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, billing, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{name}/billing" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves billing resource data of Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves billing resource data of Marketplace for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Marketplace_billing", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read billing resource data of Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update billing resource data of Marketplace for version v1alpha1 from group catalog", "description" : "Update billing resource data of Marketplace for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Marketplace_billing", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated billing resource data of Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Marketplace for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Marketplace_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Marketplace for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Marketplace for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Marketplace_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Marketplace for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Marketplace_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Marketplace for version v1alpha1 from group catalog", "description" : "Update Languages data for Marketplace for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Marketplace_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Marketplace for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Marketplace for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Marketplace_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Marketplace for version v1alpha1 from group catalog", "description" : "Update Languages data for Marketplace for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Marketplace_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Marketplace resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Marketplace for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Marketplace" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedproducts." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedproducts." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "201" : { "description" : "Create a new PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing PublishedProduct for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed PublishedProduct for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Update PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}/references" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}/status" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedproducts/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedProduct", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedProduct_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedProduct_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedProduct for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/publishedproducts" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedProduct for version v1alpha1 from group catalog", "description" : "Retrieves PublishedProduct for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedProduct resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedProduct for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedproducts." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedProduct" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog", "description" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_PublishedProduct", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedProduct for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedproducts." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "responses" : { "200" : { "description" : "Update ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductVisibility for version v1alpha1 from group catalog", "description" : "Retrieves ProductVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productplanvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productplanvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productplanvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductPlanVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductPlanVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productplanvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductPlanVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductPlanVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/productplanvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ProductPlanVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ProductPlanVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlanVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlanVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlanVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductplanvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductplanvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductplanvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductplanvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Update ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductplanvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductplanvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductplanvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductPlanVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductPlanVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerProductPlanVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/consumerproductplanvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog", "description" : "Retrieves ConsumerProductPlanVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductPlanVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerProductPlanVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductplanvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductPlanVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ConsumerProductPlanVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerProductPlanVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductplanvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "responses" : { "200" : { "description" : "Update ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerproductvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerProductVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerProductVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerProductVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/consumerproductvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog", "description" : "Retrieves ConsumerProductVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerProductVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerProductVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerProductVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ConsumerProductVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerProductVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerproductvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/marketplaces/{marketplaceName}/categoryvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CategoryVisibility for version v1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves a count of CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CategoryVisibility for version v1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Create CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/categoryvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Remove CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing CategoryVisibility for version v1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed CategoryVisibility for version v1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Update CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Update CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Patch CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1_Marketplace_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/categoryvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_CategoryVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_CategoryVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/categoryvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_CategoryVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_CategoryVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/categoryvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_CategoryVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_CategoryVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CategoryVisibility for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/categoryvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1 from group catalog", "description" : "Retrieves CategoryVisibility for version v1 from group catalog", "operationId" : "list_catalog_v1_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CategoryVisibility for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.CategoryVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CategoryVisibility for version v1 from group catalog", "description" : "Retrieves a count of CategoryVisibility for version v1 from group catalog", "operationId" : "count_catalog_v1_CategoryVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CategoryVisibility for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/categoryvisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/categoryvisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Update CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/categoryvisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_CategoryVisibility_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_CategoryVisibility_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/categoryvisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_CategoryVisibility_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_CategoryVisibility_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/categoryvisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the CategoryVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_CategoryVisibility_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_CategoryVisibility_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CategoryVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categoryvisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog", "description" : "Retrieves CategoryVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.CategoryVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CategoryVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.CategoryVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_CategoryVisibility", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.featured\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CategoryVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of categoryvisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publisheddocumentresources" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Create PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "responses" : { "201" : { "description" : "Create a new PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Remove PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing PublishedDocumentResource for version v1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed PublishedDocumentResource for version v1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Update PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Update PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Patch PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1_Marketplace_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedDocumentResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedDocumentResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedDocumentResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedDocumentResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedDocumentResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedDocumentResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedDocumentResource for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/publisheddocumentresources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1 from group catalog", "description" : "Retrieves PublishedDocumentResource for version v1 from group catalog", "operationId" : "list_catalog_v1_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedDocumentResource for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.PublishedDocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog", "description" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog", "operationId" : "count_catalog_v1_PublishedDocumentResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedDocumentResource for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publisheddocumentresources" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "responses" : { "201" : { "description" : "Create a new PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Update PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedDocumentResource_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedDocumentResource_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedDocumentResource_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedDocumentResource_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publisheddocumentresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedDocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedDocumentResource_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedDocumentResource_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedDocumentResource for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/publisheddocumentresources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves PublishedDocumentResource for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedDocumentResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedDocumentResource for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedDocumentResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog", "description" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_PublishedDocumentResource", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedDocumentResource for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publisheddocumentresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publishedstages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedStage for version v1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves a count of PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedStage for version v1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Create PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "responses" : { "201" : { "description" : "Create a new PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publishedstages/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Remove PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing PublishedStage for version v1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed PublishedStage for version v1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Update PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Update PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Patch PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1_Marketplace_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publishedstages/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedStage_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedStage_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publishedstages/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedStage_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedStage_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/marketplaces/{marketplaceName}/publishedstages/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1_Marketplace_PublishedStage_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1_Marketplace_PublishedStage_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedStage for version v1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/publishedstages" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1 from group catalog", "description" : "Retrieves PublishedStage for version v1 from group catalog", "operationId" : "list_catalog_v1_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedStage for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.PublishedStage" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedStage for version v1 from group catalog", "description" : "Retrieves a count of PublishedStage for version v1 from group catalog", "operationId" : "count_catalog_v1_PublishedStage", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedStage for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedstages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "responses" : { "201" : { "description" : "Create a new PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedstages/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing PublishedStage for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed PublishedStage for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Update PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedstages/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedStage_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedStage_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedstages/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedStage_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedStage_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/publishedstages/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the PublishedStage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_PublishedStage_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_PublishedStage_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for PublishedStage for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/publishedstages" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves PublishedStage for version v1alpha1 from group catalog", "description" : "Retrieves PublishedStage for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.PublishedStage resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type PublishedStage for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.PublishedStage" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog", "description" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_PublishedStage", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of PublishedStage for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of publishedstages." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/stagevisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stagevisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stagevisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/stagevisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the StageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing StageVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed StageVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "responses" : { "200" : { "description" : "Update StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/stagevisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the StageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_StageVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_StageVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/stagevisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the StageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_StageVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_StageVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/stagevisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the StageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_StageVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_StageVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for StageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stagevisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves StageVisibility for version v1alpha1 from group catalog", "description" : "Retrieves StageVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.StageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type StageVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stagevisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.StageVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_StageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of StageVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of stagevisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerstagevisibility" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerstagevisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerstagevisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "responses" : { "201" : { "description" : "Create a new ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerstagevisibility/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerStageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "responses" : { "200" : { "description" : "Update ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerstagevisibility/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerStageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerstagevisibility/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerStageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/consumerstagevisibility/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ConsumerStageVisibility", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_ConsumerStageVisibility_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ConsumerStageVisibility for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/consumerstagevisibility" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog", "description" : "Retrieves ConsumerStageVisibility for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ConsumerStageVisibility resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ConsumerStageVisibility for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerstagevisibility." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ConsumerStageVisibility" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog", "description" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ConsumerStageVisibility", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ConsumerStageVisibility for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of consumerstagevisibility." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assistedsearch." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assistedsearch." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "201" : { "description" : "Create a new AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssistedSearch", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssistedSearch for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssistedSearch for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "200" : { "description" : "Update AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch/{name}/state" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssistedSearch", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AssistedSearch_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AssistedSearch_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssistedSearch", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AssistedSearch_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AssistedSearch_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssistedSearch", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AssistedSearch_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AssistedSearch_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/assistedsearch/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssistedSearch", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AssistedSearch_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AssistedSearch_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssistedSearch for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assistedsearch" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssistedSearch for version v1alpha1 from group catalog", "description" : "Retrieves AssistedSearch for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssistedSearch resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssistedSearch for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assistedsearch." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssistedSearch" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssistedSearch", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssistedSearch for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assistedsearch." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/supportcontacts" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SupportContact for version v1 from group catalog", "description" : "Retrieves SupportContact for version v1 from group catalog", "operationId" : "list_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SupportContact for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of supportcontacts." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SupportContact for version v1 from group catalog", "description" : "Retrieves a count of SupportContact for version v1 from group catalog", "operationId" : "count_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SupportContact for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of supportcontacts." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SupportContact for version v1 from group catalog", "description" : "Create SupportContact for version v1 from group catalog", "operationId" : "create_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "responses" : { "201" : { "description" : "Create a new SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/supportcontacts/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SupportContact for version v1 from group catalog", "description" : "Retrieves SupportContact for version v1 from group catalog", "operationId" : "read_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SupportContact for version v1 from group catalog", "description" : "Remove SupportContact for version v1 from group catalog", "operationId" : "remove_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SupportContact for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SupportContact for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SupportContact for version v1 from group catalog", "description" : "Update SupportContact for version v1 from group catalog", "operationId" : "update_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Update SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SupportContact for version v1 from group catalog", "description" : "Patch SupportContact for version v1 from group catalog", "operationId" : "patch_catalog_v1_SupportContact", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/supportcontacts/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SupportContact for version v1 from group catalog", "description" : "Retrieves Extension resource data of SupportContact for version v1 from group catalog", "operationId" : "read_catalog_v1_SupportContact_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SupportContact for version v1 from group catalog", "description" : "Update Extension resource data of SupportContact for version v1 from group catalog", "operationId" : "update_catalog_v1_SupportContact_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/supportcontacts/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SupportContact for version v1 from group catalog", "description" : "Retrieves Languages data for SupportContact for version v1 from group catalog", "operationId" : "read_catalog_v1_SupportContact_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SupportContact for version v1 from group catalog", "description" : "Update Languages data for SupportContact for version v1 from group catalog", "operationId" : "update_catalog_v1_SupportContact_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/supportcontacts/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SupportContact for version v1 from group catalog", "description" : "Retrieves Languages data for SupportContact for version v1 from group catalog", "operationId" : "read_catalog_v1_SupportContact_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SupportContact for version v1 from group catalog", "description" : "Update Languages data for SupportContact for version v1 from group catalog", "operationId" : "update_catalog_v1_SupportContact_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SupportContact for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves SupportContact for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SupportContact for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of supportcontacts." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves a count of SupportContact for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SupportContact for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of supportcontacts." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SupportContact for version v1alpha1 from group catalog", "description" : "Create SupportContact for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "responses" : { "201" : { "description" : "Create a new SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves SupportContact for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SupportContact for version v1alpha1 from group catalog", "description" : "Remove SupportContact for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SupportContact for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SupportContact for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SupportContact for version v1alpha1 from group catalog", "description" : "Update SupportContact for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Update SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SupportContact for version v1alpha1 from group catalog", "description" : "Patch SupportContact for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_SupportContact", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of SupportContact for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SupportContact_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SupportContact for version v1alpha1 from group catalog", "description" : "Update Extension resource data of SupportContact for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SupportContact_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for SupportContact for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SupportContact_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SupportContact for version v1alpha1 from group catalog", "description" : "Update Languages data for SupportContact for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SupportContact_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SupportContact for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for SupportContact for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SupportContact_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SupportContact for version v1alpha1 from group catalog", "description" : "Update Languages data for SupportContact for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SupportContact_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SupportContact resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SupportContact for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SupportContact" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Product for version v1 from group catalog", "description" : "Retrieves Product for version v1 from group catalog", "operationId" : "list_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Product for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of products." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Product for version v1 from group catalog", "description" : "Retrieves a count of Product for version v1 from group catalog", "operationId" : "count_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Product for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of products." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Product for version v1 from group catalog", "description" : "Create Product for version v1 from group catalog", "operationId" : "create_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "201" : { "description" : "Create a new Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Product for version v1 from group catalog", "description" : "Retrieves Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Product for version v1 from group catalog", "description" : "Remove Product for version v1 from group catalog", "operationId" : "remove_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Product for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Product for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Product for version v1 from group catalog", "description" : "Update Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Update Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Product for version v1 from group catalog", "description" : "Patch Product for version v1 from group catalog", "operationId" : "patch_catalog_v1_Product", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, latestrelease, status, state, references, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Product for version v1 from group catalog", "description" : "Retrieves icon resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Product for version v1 from group catalog", "description" : "Update icon resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/latestrelease" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves latestrelease resource data of Product for version v1 from group catalog", "description" : "Retrieves latestrelease resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_latestrelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read latestrelease resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update latestrelease resource data of Product for version v1 from group catalog", "description" : "Update latestrelease resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_latestrelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated latestrelease resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Product for version v1 from group catalog", "description" : "Retrieves status resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Product for version v1 from group catalog", "description" : "Update status resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Product for version v1 from group catalog", "description" : "Retrieves state resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Product for version v1 from group catalog", "description" : "Update state resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Product for version v1 from group catalog", "description" : "Retrieves references resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Product for version v1 from group catalog", "description" : "Update references resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Product for version v1 from group catalog", "description" : "Retrieves Extension resource data of Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Product for version v1 from group catalog", "description" : "Update Extension resource data of Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Product for version v1 from group catalog", "description" : "Retrieves Languages data for Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Product for version v1 from group catalog", "description" : "Update Languages data for Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Product for version v1 from group catalog", "description" : "Retrieves Languages data for Product for version v1 from group catalog", "operationId" : "read_catalog_v1_Product_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Product for version v1 from group catalog", "description" : "Update Languages data for Product for version v1 from group catalog", "operationId" : "update_catalog_v1_Product_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Product for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Product for version v1alpha1 from group catalog", "description" : "Retrieves Product for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, latestrelease, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Product for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of products." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Product for version v1alpha1 from group catalog", "description" : "Retrieves a count of Product for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Product for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of products." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Product for version v1alpha1 from group catalog", "description" : "Create Product for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, latestrelease, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "201" : { "description" : "Create a new Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Product for version v1alpha1 from group catalog", "description" : "Retrieves Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, latestrelease, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Product for version v1alpha1 from group catalog", "description" : "Remove Product for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Product for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Product for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Product for version v1alpha1 from group catalog", "description" : "Update Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, latestrelease, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Update Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Product for version v1alpha1 from group catalog", "description" : "Patch Product for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_Product", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, latestrelease, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of Product for version v1alpha1 from group catalog", "description" : "Update references resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Product for version v1alpha1 from group catalog", "description" : "Update icon resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/latestrelease" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves latestrelease resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves latestrelease resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_latestrelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read latestrelease resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update latestrelease resource data of Product for version v1alpha1 from group catalog", "description" : "Update latestrelease resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_latestrelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated latestrelease resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of Product for version v1alpha1 from group catalog", "description" : "Update state resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Product for version v1alpha1 from group catalog", "description" : "Update status resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Product for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Product for version v1alpha1 from group catalog", "description" : "Update Extension resource data of Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Product for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Product for version v1alpha1 from group catalog", "description" : "Update Languages data for Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Product for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for Product for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_Product_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Product for version v1alpha1 from group catalog", "description" : "Update Languages data for Product for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_Product_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Product resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Product for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Product" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductRelease for version v1 from group catalog", "description" : "Retrieves ProductRelease for version v1 from group catalog", "operationId" : "list_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.version * status.level * spec.state * spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductRelease for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreleases." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductRelease for version v1 from group catalog", "description" : "Retrieves a count of ProductRelease for version v1 from group catalog", "operationId" : "count_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.version * status.level * spec.state * spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductRelease for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreleases." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductRelease for version v1 from group catalog", "description" : "Create ProductRelease for version v1 from group catalog", "operationId" : "create_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "201" : { "description" : "Create a new ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductRelease for version v1 from group catalog", "description" : "Retrieves ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductRelease for version v1 from group catalog", "description" : "Remove ProductRelease for version v1 from group catalog", "operationId" : "remove_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductRelease for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductRelease for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductRelease for version v1 from group catalog", "description" : "Update ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Update ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductRelease for version v1 from group catalog", "description" : "Patch ProductRelease for version v1 from group catalog", "operationId" : "patch_catalog_v1_ProductRelease", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ProductRelease for version v1 from group catalog", "description" : "Retrieves references resource data of ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ProductRelease for version v1 from group catalog", "description" : "Update references resource data of ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of ProductRelease for version v1 from group catalog", "description" : "Retrieves icon resource data of ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of ProductRelease for version v1 from group catalog", "description" : "Update icon resource data of ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ProductRelease for version v1 from group catalog", "description" : "Retrieves status resource data of ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ProductRelease for version v1 from group catalog", "description" : "Update status resource data of ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductRelease for version v1 from group catalog", "description" : "Retrieves Extension resource data of ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductRelease for version v1 from group catalog", "description" : "Update Extension resource data of ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductRelease for version v1 from group catalog", "description" : "Retrieves Languages data for ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductRelease for version v1 from group catalog", "description" : "Update Languages data for ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductRelease for version v1 from group catalog", "description" : "Retrieves Languages data for ProductRelease for version v1 from group catalog", "operationId" : "read_catalog_v1_ProductRelease_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductRelease for version v1 from group catalog", "description" : "Update Languages data for ProductRelease for version v1 from group catalog", "operationId" : "update_catalog_v1_ProductRelease_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductRelease for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves ProductRelease for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.version * status.level * spec.state * spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductRelease for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreleases." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductRelease for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.version * status.level * spec.state * spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductRelease for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreleases." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductRelease for version v1alpha1 from group catalog", "description" : "Create ProductRelease for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "201" : { "description" : "Create a new ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductRelease for version v1alpha1 from group catalog", "description" : "Remove ProductRelease for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductRelease for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductRelease for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductRelease for version v1alpha1 from group catalog", "description" : "Update ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Update ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductRelease for version v1alpha1 from group catalog", "description" : "Patch ProductRelease for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_ProductRelease", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, references, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Update references resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_references", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/icon" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves icon resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Update icon resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_icon", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Update status resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductRelease for version v1alpha1 from group catalog", "description" : "Update Extension resource data of ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductRelease for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductRelease for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductRelease for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductRelease_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductRelease for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductRelease for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductRelease_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductRelease resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductRelease for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductRelease" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlanUnit for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanunits." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlanUnit for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanunits." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Create ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "responses" : { "201" : { "description" : "Create a new ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Remove ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductPlanUnit for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductPlanUnit for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Update ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Patch ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_ProductPlanUnit", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Update Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanUnit resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanUnit for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanUnit" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlan for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * spec.type * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlan for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplans." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductPlan for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * spec.type * state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlan for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplans." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductPlan for version v1alpha1 from group catalog", "description" : "Create ProductPlan for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "201" : { "description" : "Create a new ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductPlan for version v1alpha1 from group catalog", "description" : "Remove ProductPlan for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductPlan for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductPlan for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductPlan for version v1alpha1 from group catalog", "description" : "Update ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Update ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductPlan for version v1alpha1 from group catalog", "description" : "Patch ProductPlan for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_ProductPlan", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, references, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/state" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves state resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Update state resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/references" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves references resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Update references resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/status" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves status resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Update status resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductPlan for version v1alpha1 from group catalog", "description" : "Update Extension resource data of ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlan for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlan for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for ProductPlan for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_ProductPlan_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlan for version v1alpha1 from group catalog", "description" : "Update Languages data for ProductPlan for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_ProductPlan_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlan resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlan for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlan" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/subscriptionrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "list_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionRequestDefinition for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves a count of SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "count_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionRequestDefinition for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Create SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "create_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/subscriptionrequestdefinitions/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "read_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Remove SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "remove_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SubscriptionRequestDefinition for version v1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SubscriptionRequestDefinition for version v1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Update SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "update_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Patch SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "patch_catalog_v1_SubscriptionRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/subscriptionrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "read_catalog_v1_SubscriptionRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Update Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "update_catalog_v1_SubscriptionRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/subscriptionrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "read_catalog_v1_SubscriptionRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Update Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "update_catalog_v1_SubscriptionRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/subscriptionrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "read_catalog_v1_SubscriptionRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "description" : "Update Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "operationId" : "update_catalog_v1_SubscriptionRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionRequestDefinition for version v1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type SubscriptionRequestDefinition for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves a count of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of SubscriptionRequestDefinition for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of subscriptionrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Create SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "create_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Remove SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "remove_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing SubscriptionRequestDefinition for version v1alpha1 from group catalog. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed SubscriptionRequestDefinition for version v1alpha1 from group catalog" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Update SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Patch SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "patch_catalog_v1alpha1_SubscriptionRequestDefinition", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Update Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Update Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "description" : "Update Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.SubscriptionRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for SubscriptionRequestDefinition for version v1alpha1 from group catalog", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.SubscriptionRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "list_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "count_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Create ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "create_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "201" : { "description" : "Create a new ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs/{name}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Remove ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "remove_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Patch ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "patch_catalog_v1alpha1_ProductPlan_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs/{name}/status" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_ProductPlanJob_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_ProductPlanJob_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs/{name}/{extension}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_ProductPlanJob_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_ProductPlanJob_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs/{name}/languages" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_ProductPlanJob_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_ProductPlanJob_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/productplanjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductPlanJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_ProductPlanJob_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_ProductPlanJob_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductPlanJob for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog", "description" : "Retrieves ProductPlanJob for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductPlanJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductPlanJob for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductPlanJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductPlanJob", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state * spec.action.type\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductPlanJob for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productplanjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/productplans/{productplanName}/quotas" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "list_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Quota for version v1 from group catalog in scope ProductPlan", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves a count of Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "count_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Quota for version v1 from group catalog in scope ProductPlan.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Quota for version v1 from group catalog in scope ProductPlan", "description" : "Create Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "create_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "201" : { "description" : "Create a new Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productplans/{productplanName}/quotas/{name}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Quota for version v1 from group catalog in scope ProductPlan", "description" : "Remove Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "remove_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Quota for version v1 from group catalog in scope ProductPlan. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Quota for version v1 from group catalog in scope ProductPlan" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Quota for version v1 from group catalog in scope ProductPlan", "description" : "Update Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "200" : { "description" : "Update Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Quota for version v1 from group catalog in scope ProductPlan", "description" : "Patch Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "patch_catalog_v1_ProductPlan_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productplans/{productplanName}/quotas/{name}/status" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves status resource data of Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1_ProductPlan_Quota_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Quota for version v1 from group catalog in scope ProductPlan", "description" : "Update status resource data of Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1_ProductPlan_Quota_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productplans/{productplanName}/quotas/{name}/{extension}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1_ProductPlan_Quota_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "description" : "Update Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1_ProductPlan_Quota_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productplans/{productplanName}/quotas/{name}/languages" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1_ProductPlan_Quota_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Quota for version v1 from group catalog in scope ProductPlan", "description" : "Update Languages data for Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1_ProductPlan_Quota_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productplans/{productplanName}/quotas/{name}/languages-{code}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Quota for version v1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1_ProductPlan_Quota_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Quota for version v1 from group catalog in scope ProductPlan", "description" : "Update Languages data for Quota for version v1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1_ProductPlan_Quota_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Quota for version v1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/quotas" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1 from group catalog", "description" : "Retrieves Quota for version v1 from group catalog", "operationId" : "list_catalog_v1_Quota", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Quota for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Quota" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Quota for version v1 from group catalog", "description" : "Retrieves a count of Quota for version v1 from group catalog", "operationId" : "count_catalog_v1_Quota", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Quota for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "list_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Quota for version v1alpha1 from group catalog in scope ProductPlan", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves a count of Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "count_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Quota for version v1alpha1 from group catalog in scope ProductPlan.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Create Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "create_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "201" : { "description" : "Create a new Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas/{name}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Remove Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "remove_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Quota for version v1alpha1 from group catalog in scope ProductPlan. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Quota for version v1alpha1 from group catalog in scope ProductPlan" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "200" : { "description" : "Update Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Patch Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "patch_catalog_v1alpha1_ProductPlan_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas/{name}/status" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_Quota_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_Quota_status", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas/{name}/{extension}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_Quota_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_Quota_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas/{name}/languages" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_Quota_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_Quota_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/quotas/{name}/languages-{code}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Quota", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_Quota_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_Quota_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Quota for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/quotas" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Quota for version v1alpha1 from group catalog", "description" : "Retrieves Quota for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Quota resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Quota for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Quota" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Quota for version v1alpha1 from group catalog", "description" : "Retrieves a count of Quota for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Quota", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Quota for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of quotas." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/products/{productName}/productreviews" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves ProductReview for version v1 from group catalog in scope Product", "operationId" : "list_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductReview for version v1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves a count of ProductReview for version v1 from group catalog in scope Product", "operationId" : "count_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductReview for version v1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductReview for version v1 from group catalog in scope Product", "description" : "Create ProductReview for version v1 from group catalog in scope Product", "operationId" : "create_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductReview for version v1 from group catalog in scope Product", "description" : "Remove ProductReview for version v1 from group catalog in scope Product", "operationId" : "remove_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductReview for version v1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductReview for version v1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductReview for version v1 from group catalog in scope Product", "description" : "Update ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Update ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductReview for version v1 from group catalog in scope Product", "description" : "Patch ProductReview for version v1 from group catalog in scope Product", "operationId" : "patch_catalog_v1_Product_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}/marketplace" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Update marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}/state" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves state resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Update state resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductReview for version v1 from group catalog in scope Product", "description" : "Update Extension resource data of ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductReview for version v1 from group catalog in scope Product", "description" : "Update Languages data for ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productreviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductReview for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductReview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductReview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductReview for version v1 from group catalog in scope Product", "description" : "Update Languages data for ProductReview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductReview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductReview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreviews" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1 from group catalog", "description" : "Retrieves ProductReview for version v1 from group catalog", "operationId" : "list_catalog_v1_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductReview for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductReview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductReview for version v1 from group catalog", "description" : "Retrieves a count of ProductReview for version v1 from group catalog", "operationId" : "count_catalog_v1_ProductReview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductReview for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/products/{productName}/productreviews" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductReview for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Create ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Remove ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductReview for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductReview for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Update ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Patch ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}/marketplace" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview_marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview_marketplace", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}/state" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview_state", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview_extension", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview_languages", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productreviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductReview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductReview_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductReview_languages_code", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductReview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreviews" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductReview for version v1alpha1 from group catalog", "description" : "Retrieves ProductReview for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductReview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, state, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductReview for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductReview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductReview", "deprecated" : true, "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * state.name * spec.rating * scopeResource.status.level * scopeResource.state * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductReview for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productreviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/definitions/v1alpha1/groups" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves ResourceGroup for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceGroup for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of groups." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves a count of ResourceGroup for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceGroup for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of groups." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ResourceGroup for version v1alpha1 from group definitions", "description" : "Create ResourceGroup for version v1alpha1 from group definitions", "operationId" : "create_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "responses" : { "201" : { "description" : "Create a new ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves ResourceGroup for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ResourceGroup for version v1alpha1 from group definitions", "description" : "Remove ResourceGroup for version v1alpha1 from group definitions", "operationId" : "remove_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ResourceGroup for version v1alpha1 from group definitions. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ResourceGroup for version v1alpha1 from group definitions" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ResourceGroup for version v1alpha1 from group definitions", "description" : "Update ResourceGroup for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "responses" : { "200" : { "description" : "Update ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ResourceGroup for version v1alpha1 from group definitions", "description" : "Patch ResourceGroup for version v1alpha1 from group definitions", "operationId" : "patch_definitions_v1alpha1_ResourceGroup", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_ResourceGroup_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "description" : "Update Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_ResourceGroup_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves Languages data for ResourceGroup for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_ResourceGroup_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceGroup for version v1alpha1 from group definitions", "description" : "Update Languages data for ResourceGroup for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_ResourceGroup_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceGroup for version v1alpha1 from group definitions", "description" : "Retrieves Languages data for ResourceGroup for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_ResourceGroup_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceGroup for version v1alpha1 from group definitions", "description" : "Update Languages data for ResourceGroup for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_ResourceGroup_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceGroup resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceGroup for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceGroup" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resources" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "list_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "count_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Create ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "create_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resources/{name}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Remove ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "remove_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "responses" : { "200" : { "description" : "Update ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Patch ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "patch_definitions_v1alpha1_ResourceGroup_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinition_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinition_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resources/{name}/languages" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinition_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinition_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinition_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinition_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceDefinition for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/resources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions", "description" : "Retrieves ResourceDefinition for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceDefinition for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions", "description" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_ResourceDefinition", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceDefinition for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/definitions/v1alpha1/groups/{groupName}/resourceversions" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "list_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourceversions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "count_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourceversions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Create ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "create_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "responses" : { "201" : { "description" : "Create a new ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resourceversions/{name}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinitionVersion", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Remove ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "remove_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "responses" : { "200" : { "description" : "Update ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Patch ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "patch_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resourceversions/{name}/{extension}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinitionVersion", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resourceversions/{name}/languages" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinitionVersion", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/resourceversions/{name}/languages-{code}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ResourceDefinitionVersion", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_ResourceDefinitionVersion_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ResourceDefinitionVersion for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/resourceversions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions", "description" : "Retrieves ResourceDefinitionVersion for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.ResourceDefinitionVersion resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ResourceDefinitionVersion for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourceversions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.ResourceDefinitionVersion" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions", "description" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_ResourceDefinitionVersion", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ResourceDefinitionVersion for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resourceversions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/definitions/v1alpha1/groups/{groupName}/commandlines" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "list_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of commandlines." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "count_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of commandlines." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Create CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "create_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "responses" : { "201" : { "description" : "Create a new CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/commandlines/{name}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CommandLineInterface", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Remove CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "remove_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "responses" : { "200" : { "description" : "Update CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Patch CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "patch_definitions_v1alpha1_ResourceGroup_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/commandlines/{name}/{extension}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the CommandLineInterface", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_CommandLineInterface_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_CommandLineInterface_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/commandlines/{name}/languages" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the CommandLineInterface", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_CommandLineInterface_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_CommandLineInterface_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/commandlines/{name}/languages-{code}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the CommandLineInterface", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_CommandLineInterface_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_CommandLineInterface_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for CommandLineInterface for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/commandlines" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions", "description" : "Retrieves CommandLineInterface for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.CommandLineInterface resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type CommandLineInterface for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of commandlines." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.CommandLineInterface" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions", "description" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_CommandLineInterface", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of CommandLineInterface for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of commandlines." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/definitions/v1alpha1/components" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Component for version v1alpha1 from group definitions", "description" : "Retrieves Component for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Component for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of components." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Component for version v1alpha1 from group definitions", "description" : "Retrieves a count of Component for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Component for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of components." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Component for version v1alpha1 from group definitions", "description" : "Create Component for version v1alpha1 from group definitions", "operationId" : "create_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "responses" : { "201" : { "description" : "Create a new Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{name}" : { "parameters" : [ { "name" : "name", "description" : "The name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Component for version v1alpha1 from group definitions", "description" : "Retrieves Component for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Component for version v1alpha1 from group definitions", "description" : "Remove Component for version v1alpha1 from group definitions", "operationId" : "remove_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Component for version v1alpha1 from group definitions. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Component for version v1alpha1 from group definitions" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Component for version v1alpha1 from group definitions", "description" : "Update Component for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "responses" : { "200" : { "description" : "Update Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Component for version v1alpha1 from group definitions", "description" : "Patch Component for version v1alpha1 from group definitions", "operationId" : "patch_definitions_v1alpha1_Component", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{name}/{extension}" : { "parameters" : [ { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Component for version v1alpha1 from group definitions", "description" : "Retrieves Extension resource data of Component for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_Component_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Component for version v1alpha1 from group definitions", "description" : "Update Extension resource data of Component for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_Component_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{name}/languages" : { "parameters" : [ { "name" : "name", "description" : "The name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Component for version v1alpha1 from group definitions", "description" : "Retrieves Languages data for Component for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_Component_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Component for version v1alpha1 from group definitions", "description" : "Update Languages data for Component for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_Component_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{name}/languages-{code}" : { "parameters" : [ { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Component for version v1alpha1 from group definitions", "description" : "Retrieves Languages data for Component for version v1alpha1 from group definitions", "operationId" : "read_definitions_v1alpha1_Component_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Component for version v1alpha1 from group definitions", "description" : "Update Languages data for Component for version v1alpha1 from group definitions", "operationId" : "update_definitions_v1alpha1_Component_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.Component resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Component for version v1alpha1 from group definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.Component" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "list_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMapping for version v1alpha1 from group catalog in scope Asset", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "count_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog in scope Asset.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Create AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "create_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "201" : { "description" : "Create a new AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings/{name}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Remove AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "remove_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetMapping for version v1alpha1 from group catalog in scope Asset. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetMapping for version v1alpha1 from group catalog in scope Asset" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Update AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Update AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Patch AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "patch_catalog_v1alpha1_Asset_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings/{name}/status" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetMapping_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Update status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetMapping_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings/{name}/{extension}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetMapping_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Update Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetMapping_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings/{name}/languages" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetMapping_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetMapping_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetmappings/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetMapping_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetMapping_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMapping for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetmappings" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group catalog", "description" : "Retrieves AssetMapping for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMapping for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetMapping" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssetMapping", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.status.level * scopeResource.spec.type * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMapping for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Create AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "201" : { "description" : "Create a new AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Remove AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetMapping for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetMapping for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Update AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Update AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Patch AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings/{name}/status" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMapping_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Update status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMapping_status", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMapping_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMapping_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMapping_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMapping_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/assetmappings/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetMapping", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AssetMapping_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AssetMapping_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetMapping for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/assetmappings" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetMapping for version v1alpha1 from group management", "description" : "Retrieves AssetMapping for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AssetMapping resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetMapping for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AssetMapping" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetMapping for version v1alpha1 from group management", "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_AssetMapping", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetMapping for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetmappings." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "list_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetResource for version v1alpha1 from group catalog in scope Asset", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "count_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope Asset.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Create AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "create_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "201" : { "description" : "Create a new AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Remove AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "remove_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetResource for version v1alpha1 from group catalog in scope Asset. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetResource for version v1alpha1 from group catalog in scope Asset" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Update AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Patch AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "patch_catalog_v1alpha1_Asset_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/overview" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_overview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_overview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated overview resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/references" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/releasehash" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_releasehash", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_releasehash", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/status" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/{extension}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/languages" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/assetresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AssetResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AssetResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetResource for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetresources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetResource for version v1alpha1 from group catalog", "description" : "Retrieves AssetResource for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetResource for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "list_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "count_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.sourceReleaseState.name * status.level * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.spec.type * scopeResource.state * spec.dataClassification\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetResource for version v1alpha1 from group catalog in scope AssetRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetresources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Create AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "create_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "201" : { "description" : "Create a new AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Remove AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "remove_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetResource for version v1alpha1 from group catalog in scope AssetRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetResource for version v1alpha1 from group catalog in scope AssetRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Update AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Patch AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "patch_catalog_v1alpha1_AssetRelease_AssetResource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, overview, references, releasehash, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/overview" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_overview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_overview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated overview resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/references" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/releasehash" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_releasehash", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_releasehash", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated releasehash resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/status" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/{extension}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/languages" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/assetresources/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AssetResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AssetResource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetResource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetResource for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetResource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "201" : { "description" : "Create a new AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Update AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/authorization" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_authorization", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_authorization", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated authorization resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/applicationprofile" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_applicationprofile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_applicationprofile", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated applicationprofile resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/references" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/webhooks" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_webhooks", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_webhooks", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated webhooks resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/assetrequestdefinitions/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AssetRequestDefinition_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRequestDefinition for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetrequestdefinitions" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves AssetRequestDefinition for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequestDefinition resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, authorization, applicationprofile, references, webhooks, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetRequestDefinition for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequestdefinitions." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequestDefinition" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssetRequestDefinition", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetRequestDefinition for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequestdefinitions." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "list_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * approval.previousState * marketplace.resource.owner.user.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * approval.state.name * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetRequest for version v1alpha1 from group catalog in scope Application", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequests." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "count_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * approval.previousState * marketplace.resource.owner.user.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * approval.state.name * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog in scope Application.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequests." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Create AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "create_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "201" : { "description" : "Create a new AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Remove AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "remove_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AssetRequest for version v1alpha1 from group catalog in scope Application. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AssetRequest for version v1alpha1 from group catalog in scope Application" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Update AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Patch AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "patch_catalog_v1alpha1_Application_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/marketplace" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_marketplace", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated marketplace resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/data" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_data", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_data", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated data resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/references" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_references", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated references resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/approval" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_approval", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_approval", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated approval resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/status" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/{extension}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/languages" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/assetrequests/{name}/languages-{code}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AssetRequest", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AssetRequest_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AssetRequest_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AssetRequest for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetrequests" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AssetRequest for version v1alpha1 from group catalog", "description" : "Retrieves AssetRequest for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * approval.previousState * marketplace.resource.owner.user.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * approval.state.name * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AssetRequest resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, marketplace, data, references, approval, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AssetRequest for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequests." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AssetRequest" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog", "description" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AssetRequest", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.marketplace.resource.owner.id * status.level * marketplace.resource.owner.id * approval.previousState * marketplace.resource.owner.user.id * scopeResource.marketplace.resource.owner.organization.id * scopeResource.state * approval.state.name * marketplace.resource.owner.organization.id\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AssetRequest for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of assetrequests." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/products/{productName}/documents" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope Product", "description" : "Retrieves Document for version v1 from group catalog in scope Product", "operationId" : "list_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1 from group catalog in scope Product", "description" : "Retrieves a count of Document for version v1 from group catalog in scope Product", "operationId" : "count_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1 from group catalog in scope Product", "description" : "Create Document for version v1 from group catalog in scope Product", "operationId" : "create_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope Product", "description" : "Retrieves Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1 from group catalog in scope Product", "description" : "Remove Document for version v1 from group catalog in scope Product", "operationId" : "remove_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1 from group catalog in scope Product", "description" : "Update Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1 from group catalog in scope Product", "description" : "Patch Document for version v1 from group catalog in scope Product", "operationId" : "patch_catalog_v1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}/icon" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1 from group catalog in scope Product", "description" : "Retrieves icon resource data of Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1 from group catalog in scope Product", "description" : "Update icon resource data of Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}/status" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1 from group catalog in scope Product", "description" : "Retrieves status resource data of Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1 from group catalog in scope Product", "description" : "Update status resource data of Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1 from group catalog in scope Product", "description" : "Update Extension resource data of Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope Product", "description" : "Update Languages data for Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope Product", "description" : "Update Languages data for Document for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documents" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog", "description" : "Retrieves Document for version v1 from group catalog", "operationId" : "list_catalog_v1_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1 from group catalog", "description" : "Retrieves a count of Document for version v1 from group catalog", "operationId" : "count_catalog_v1_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/products/{productName}/documents" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1alpha1 from group catalog in scope Product", "description" : "Create Document for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1alpha1 from group catalog in scope Product", "description" : "Remove Document for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1alpha1 from group catalog in scope Product", "description" : "Update Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1alpha1 from group catalog in scope Product", "description" : "Patch Document for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}/icon" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}/status" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Update status resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documents" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog", "description" : "Retrieves Document for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1alpha1 from group catalog", "description" : "Retrieves a count of Document for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Document for version v1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1 from group catalog in scope ProductRelease", "description" : "Create Document for version v1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1 from group catalog in scope ProductRelease", "description" : "Remove Document for version v1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1 from group catalog in scope ProductRelease", "description" : "Update Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1 from group catalog in scope ProductRelease", "description" : "Patch Document for version v1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}/icon" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves icon resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Update icon resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}/status" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves status resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Update status resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Document for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1alpha1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Create Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Remove Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1alpha1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1alpha1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Patch Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1alpha1_ProductRelease_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}/icon" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}/status" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "list_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1 from group catalog in scope DocumentTemplate", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "count_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentTemplate.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Create Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "create_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Remove Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "remove_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1 from group catalog in scope DocumentTemplate. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1 from group catalog in scope DocumentTemplate" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Patch Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "patch_catalog_v1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}/icon" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}/status" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}/languages" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "list_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1alpha1 from group catalog in scope DocumentTemplate", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "count_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentTemplate.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Create Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "create_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Remove Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "remove_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1alpha1 from group catalog in scope DocumentTemplate. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1alpha1 from group catalog in scope DocumentTemplate" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Patch Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "patch_catalog_v1alpha1_DocumentTemplate_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}/icon" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}/status" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}/languages" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "list_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1 from group catalog in scope DocumentCollection", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "count_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1 from group catalog in scope DocumentCollection.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1 from group catalog in scope DocumentCollection", "description" : "Create Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "create_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1 from group catalog in scope DocumentCollection", "description" : "Remove Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "remove_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1 from group catalog in scope DocumentCollection. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1 from group catalog in scope DocumentCollection" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1 from group catalog in scope DocumentCollection", "description" : "Patch Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "patch_catalog_v1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}/icon" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}/status" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves status resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update status resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}/languages" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Document for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "list_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Document for version v1alpha1 from group catalog in scope DocumentCollection", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "count_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * status.level * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Document for version v1alpha1 from group catalog in scope DocumentCollection.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of documents." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Create Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "create_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "201" : { "description" : "Create a new Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Remove Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "remove_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Document for version v1alpha1 from group catalog in scope DocumentCollection. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Document for version v1alpha1 from group catalog in scope DocumentCollection" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Patch Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "patch_catalog_v1alpha1_DocumentCollection_Document", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, icon, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}/icon" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document_icon", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated icon resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}/status" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}/{extension}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}/languages" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/documents/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Document", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Document_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Document resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Document for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Document" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope Product", "description" : "Retrieves Resource for version v1 from group catalog in scope Product", "operationId" : "list_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1 from group catalog in scope Product", "description" : "Retrieves a count of Resource for version v1 from group catalog in scope Product", "operationId" : "count_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1 from group catalog in scope Product", "description" : "Create Resource for version v1 from group catalog in scope Product", "operationId" : "create_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope Product", "description" : "Retrieves Resource for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1 from group catalog in scope Product", "description" : "Remove Resource for version v1 from group catalog in scope Product", "operationId" : "remove_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1 from group catalog in scope Product", "description" : "Update Resource for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1 from group catalog in scope Product", "description" : "Patch Resource for version v1 from group catalog in scope Product", "operationId" : "patch_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope Product properties raw data.", "description" : "Retrieves Resource for version v1 from group catalog in scope Product", "operationId" : "read_raw_catalog_v1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope Product raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1 from group catalog in scope Product", "description" : "Update Extension resource data of Resource for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope Product", "description" : "Update Languages data for Resource for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope Product", "description" : "Update Languages data for Resource for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/resources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog", "description" : "Retrieves Resource for version v1 from group catalog", "operationId" : "list_catalog_v1_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1 from group catalog", "description" : "Retrieves a count of Resource for version v1 from group catalog", "operationId" : "count_catalog_v1_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/products/{productName}/resources" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1alpha1 from group catalog in scope Product", "description" : "Create Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/resources/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1alpha1 from group catalog in scope Product", "description" : "Remove Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1alpha1 from group catalog in scope Product", "description" : "Update Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1alpha1 from group catalog in scope Product", "description" : "Patch Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product properties raw data.", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "read_raw_catalog_v1alpha1_Product_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1alpha1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1alpha1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope Product raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/resources/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/resources" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog", "description" : "Retrieves Resource for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1alpha1 from group catalog", "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1 from group catalog in scope ProductRelease", "description" : "Create Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1 from group catalog in scope ProductRelease", "description" : "Remove Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1 from group catalog in scope ProductRelease", "description" : "Update Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1 from group catalog in scope ProductRelease", "description" : "Patch Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease properties raw data.", "description" : "Retrieves Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "read_raw_catalog_v1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope ProductRelease raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Resource for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1alpha1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Create Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Remove Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1alpha1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1alpha1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Patch Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease properties raw data.", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_raw_catalog_v1alpha1_ProductRelease_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1alpha1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1alpha1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope ProductRelease raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "list_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1 from group catalog in scope DocumentTemplate", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "count_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentTemplate.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Create Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "create_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources/{name}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Remove Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "remove_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1 from group catalog in scope DocumentTemplate. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1 from group catalog in scope DocumentTemplate" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Patch Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "patch_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate properties raw data.", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_raw_catalog_v1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope DocumentTemplate raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources/{name}/languages" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documenttemplates/{documenttemplateName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1_DocumentTemplate_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1_DocumentTemplate_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "list_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "count_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentTemplate.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Create Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "create_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources/{name}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Remove Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "remove_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1alpha1 from group catalog in scope DocumentTemplate. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1alpha1 from group catalog in scope DocumentTemplate" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Patch Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "patch_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate properties raw data.", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_raw_catalog_v1alpha1_DocumentTemplate_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1alpha1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1alpha1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope DocumentTemplate raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources/{name}/languages" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "list_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1 from group catalog in scope DocumentCollection", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "count_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1 from group catalog in scope DocumentCollection.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Create Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "create_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources/{name}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Remove Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "remove_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1 from group catalog in scope DocumentCollection. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1 from group catalog in scope DocumentCollection" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Update Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Patch Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "patch_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection properties raw data.", "description" : "Retrieves Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_raw_catalog_v1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1 from group catalog in scope DocumentCollection raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Update Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources/{name}/languages" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/documentcollections/{documentcollectionName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1_DocumentCollection_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1_DocumentCollection_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "list_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Resource for version v1alpha1 from group catalog in scope DocumentCollection", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "count_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * spec.version * spec.fileType * scopeResource.spec.state * scopeResource.spec.usage.enforced * scopeResource.spec.usage.kind * scopeResource.status.level * scopeResource.spec.version * spec.contentType * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Resource for version v1alpha1 from group catalog in scope DocumentCollection.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of resources." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Create Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "create_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "201" : { "description" : "Create a new Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources/{name}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Remove Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "remove_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Resource for version v1alpha1 from group catalog in scope DocumentCollection. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Resource for version v1alpha1 from group catalog in scope DocumentCollection" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Patch Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "patch_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources/{name}/raw" : { "get" : { "summary" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection properties raw data.", "description" : "Retrieves Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_raw_catalog_v1alpha1_DocumentCollection_Resource", "tags" : [ "catalog" ], "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "field", "in" : "query", "description" : "Query string for retrieving the catalog.v1alpha1.Resource resource properties as raw data.", "required" : true, "schema" : { "type" : "string", "enum" : [ "spec.data.content" ] } }, { "name" : "download", "in" : "query", "description" : "Query string for also returning the catalog.v1alpha1.Resource resource property file name into the Content-Disposition response header.", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Read Resource for version v1alpha1 from group catalog in scope DocumentCollection raw field data" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources/{name}/{extension}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Resource_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources/{name}/languages" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Resource_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/resources/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Resource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_Resource_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Resource resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Resource for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Resource" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productoverviews" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves ProductOverview for version v1 from group catalog in scope Product", "operationId" : "list_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope Product", "operationId" : "count_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductOverview for version v1 from group catalog in scope Product", "description" : "Create ProductOverview for version v1 from group catalog in scope Product", "operationId" : "create_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productoverviews/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves ProductOverview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductOverview for version v1 from group catalog in scope Product", "description" : "Remove ProductOverview for version v1 from group catalog in scope Product", "operationId" : "remove_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductOverview for version v1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductOverview for version v1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductOverview for version v1 from group catalog in scope Product", "description" : "Update ProductOverview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductOverview for version v1 from group catalog in scope Product", "description" : "Patch ProductOverview for version v1 from group catalog in scope Product", "operationId" : "patch_catalog_v1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productoverviews/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "description" : "Update Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productoverviews/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1 from group catalog in scope Product", "description" : "Update Languages data for ProductOverview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/products/{productName}/productoverviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope Product", "operationId" : "read_catalog_v1_Product_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1 from group catalog in scope Product", "description" : "Update Languages data for ProductOverview for version v1 from group catalog in scope Product", "operationId" : "update_catalog_v1_Product_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productoverviews" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1 from group catalog", "description" : "Retrieves ProductOverview for version v1 from group catalog", "operationId" : "list_catalog_v1_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1 from group catalog", "description" : "Retrieves a count of ProductOverview for version v1 from group catalog", "operationId" : "count_catalog_v1_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/products/{productName}/productoverviews" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Create ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productoverviews/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Remove ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductOverview for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductOverview for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Patch ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productoverviews/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productoverviews/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/productoverviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productoverviews" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1alpha1 from group catalog", "description" : "Retrieves ProductOverview for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog", "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1/productreleases/{productreleaseName}/productoverviews" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Create ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/productoverviews/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Remove ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductOverview for version v1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductOverview for version v1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Update ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Patch ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/productoverviews/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/productoverviews/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1/productreleases/{productreleaseName}/productoverviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1_ProductRelease_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "description" : "Update Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1_ProductRelease_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/productoverviews" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.state * scopeResource.status.level * scopeResource.spec.version * scopeResource.state * scopeResource.spec.versionProperties.label\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of productoverviews." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Create ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "201" : { "description" : "Create a new ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/productoverviews/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Remove ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ProductOverview for version v1alpha1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ProductOverview for version v1alpha1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Patch ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1alpha1_ProductRelease_ProductOverview", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/productoverviews/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_ProductOverview_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/productoverviews/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_ProductOverview_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/productoverviews/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ProductOverview", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_ProductOverview_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ProductOverview resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ProductOverview for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ProductOverview" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/webhooks" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Webhook for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Webhook for version v1alpha1 from group management in scope Environment", "description" : "Create Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "201" : { "description" : "Create a new Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/webhooks/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Webhook for version v1alpha1 from group management in scope Environment", "description" : "Remove Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Webhook for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Webhook for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Webhook for version v1alpha1 from group management in scope Environment", "description" : "Update Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Webhook for version v1alpha1 from group management in scope Environment", "description" : "Patch Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/webhooks/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Webhook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Webhook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/webhooks/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Webhook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Webhook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/webhooks/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Webhook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Webhook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/webhooks" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group management", "description" : "Retrieves Webhook for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Webhook for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Webhook for version v1alpha1 from group management", "description" : "Retrieves a count of Webhook for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Webhook", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Webhook for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/integrations/{integrationName}/webhooks" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "list_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Webhook for version v1alpha1 from group management in scope Integration", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "count_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Webhook for version v1alpha1 from group management in scope Integration.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Webhook for version v1alpha1 from group management in scope Integration", "description" : "Create Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "create_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "201" : { "description" : "Create a new Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/webhooks/{name}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Webhook for version v1alpha1 from group management in scope Integration", "description" : "Remove Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "remove_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Webhook for version v1alpha1 from group management in scope Integration. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Webhook for version v1alpha1 from group management in scope Integration" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Webhook for version v1alpha1 from group management in scope Integration", "description" : "Update Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Webhook for version v1alpha1 from group management in scope Integration", "description" : "Patch Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "patch_management_v1alpha1_Integration_Webhook", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/webhooks/{name}/{extension}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Webhook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "description" : "Update Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Webhook_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/webhooks/{name}/languages" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Webhook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Webhook_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/webhooks/{name}/languages-{code}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Webhook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for Webhook for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Webhook_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/webhooks" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "responses" : { "201" : { "description" : "Create a new Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/webhooks/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/webhooks/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Webhook_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Webhook_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/webhooks/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Webhook_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Webhook_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/webhooks/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Webhook", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Webhook_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Webhook_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Webhook for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/webhooks" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Webhook for version v1alpha1 from group catalog", "description" : "Retrieves Webhook for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Webhook resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Webhook for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Webhook" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Webhook for version v1alpha1 from group catalog", "description" : "Retrieves a count of Webhook for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Webhook", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Webhook for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of webhooks." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "list_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ReleaseTag for version v1alpha1 from group catalog in scope Asset", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "count_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Asset.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Create ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "create_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "201" : { "description" : "Create a new ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Remove ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "remove_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ReleaseTag for version v1alpha1 from group catalog in scope Asset. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ReleaseTag for version v1alpha1 from group catalog in scope Asset" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Patch ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "patch_catalog_v1alpha1_Asset_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}/state" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}/status" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}/{extension}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}/languages" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/releasetags/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_ReleaseTag_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_ReleaseTag_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/releasetags" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ReleaseTag for version v1alpha1 from group catalog", "description" : "Retrieves ReleaseTag for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ReleaseTag for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog", "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/products/{productName}/releasetags" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type ReleaseTag for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * status.level * scopeResource.status.level * scopeResource.spec.type * state * scopeResource.state\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of ReleaseTag for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of releasetags." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Create ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "201" : { "description" : "Create a new ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Remove ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing ReleaseTag for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed ReleaseTag for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Patch ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_ReleaseTag", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, state, status, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}/state" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag_state", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated state resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}/status" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag_status", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated status resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/releasetags/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the ReleaseTag", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_ReleaseTag_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_ReleaseTag_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.ReleaseTag resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for ReleaseTag for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.ReleaseTag" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves BatchJob for version v1 from group management in scope Environment", "operationId" : "list_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type BatchJob for version v1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves a count of BatchJob for version v1 from group management in scope Environment", "operationId" : "count_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of BatchJob for version v1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create BatchJob for version v1 from group management in scope Environment", "description" : "Create BatchJob for version v1 from group management in scope Environment", "operationId" : "create_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "201" : { "description" : "Create a new BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves BatchJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove BatchJob for version v1 from group management in scope Environment", "description" : "Remove BatchJob for version v1 from group management in scope Environment", "operationId" : "remove_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing BatchJob for version v1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed BatchJob for version v1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update BatchJob for version v1 from group management in scope Environment", "description" : "Update BatchJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Update BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch BatchJob for version v1 from group management in scope Environment", "description" : "Patch BatchJob for version v1 from group management in scope Environment", "operationId" : "patch_management_v1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs/{name}/progress" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves progress resource data of BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves progress resource data of BatchJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_BatchJob_progress", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read progress resource data of BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update progress resource data of BatchJob for version v1 from group management in scope Environment", "description" : "Update progress resource data of BatchJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_BatchJob_progress", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated progress resource data of BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves Extension resource data of BatchJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_BatchJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of BatchJob for version v1 from group management in scope Environment", "description" : "Update Extension resource data of BatchJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_BatchJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for BatchJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_BatchJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for BatchJob for version v1 from group management in scope Environment", "description" : "Update Languages data for BatchJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_BatchJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/environments/{environmentName}/batchjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for BatchJob for version v1 from group management in scope Environment", "description" : "Retrieves Languages data for BatchJob for version v1 from group management in scope Environment", "operationId" : "read_management_v1_Environment_BatchJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for BatchJob for version v1 from group management in scope Environment", "description" : "Update Languages data for BatchJob for version v1 from group management in scope Environment", "operationId" : "update_management_v1_Environment_BatchJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for BatchJob for version v1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1/batchjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1 from group management", "description" : "Retrieves BatchJob for version v1 from group management", "operationId" : "list_management_v1_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type BatchJob for version v1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1.BatchJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of BatchJob for version v1 from group management", "description" : "Retrieves a count of BatchJob for version v1 from group management", "operationId" : "count_management_v1_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of BatchJob for version v1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type BatchJob for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of BatchJob for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Create BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "201" : { "description" : "Create a new BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Remove BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing BatchJob for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed BatchJob for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Update BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Update BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Patch BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs/{name}/progress" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_BatchJob_progress", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Update progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_BatchJob_progress", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated progress resource data of BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_BatchJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_BatchJob_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_BatchJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_BatchJob_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/batchjobs/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the BatchJob", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_BatchJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_BatchJob_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for BatchJob for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/batchjobs" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves BatchJob for version v1alpha1 from group management", "description" : "Retrieves BatchJob for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_BatchJob", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.BatchJob resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, progress, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type BatchJob for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.BatchJob" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of BatchJob for version v1alpha1 from group management", "description" : "Retrieves a count of BatchJob for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_BatchJob", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * spec.action * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of BatchJob for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of batchjobs." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/environments/{environmentName}/secrets" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Secret for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Secret for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Secret for version v1alpha1 from group management in scope Environment", "description" : "Create Secret for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "201" : { "description" : "Create a new Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/secrets/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Secret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Secret for version v1alpha1 from group management in scope Environment", "description" : "Remove Secret for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Secret for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Secret for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Secret for version v1alpha1 from group management in scope Environment", "description" : "Update Secret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Secret for version v1alpha1 from group management in scope Environment", "description" : "Patch Secret for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/secrets/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Secret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Secret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/secrets/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Secret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Secret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Secret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/secrets/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_Secret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for Secret for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_Secret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/secrets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group management", "description" : "Retrieves Secret for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Secret for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Secret for version v1alpha1 from group management", "description" : "Retrieves a count of Secret for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_Secret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Secret for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/integrations/{integrationName}/secrets" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Secret for version v1alpha1 from group management in scope Integration", "operationId" : "list_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Secret for version v1alpha1 from group management in scope Integration", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Integration", "operationId" : "count_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Secret for version v1alpha1 from group management in scope Integration.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Secret for version v1alpha1 from group management in scope Integration", "description" : "Create Secret for version v1alpha1 from group management in scope Integration", "operationId" : "create_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "201" : { "description" : "Create a new Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/secrets/{name}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Secret for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Secret for version v1alpha1 from group management in scope Integration", "description" : "Remove Secret for version v1alpha1 from group management in scope Integration", "operationId" : "remove_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Secret for version v1alpha1 from group management in scope Integration. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Secret for version v1alpha1 from group management in scope Integration" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Secret for version v1alpha1 from group management in scope Integration", "description" : "Update Secret for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Secret for version v1alpha1 from group management in scope Integration", "description" : "Patch Secret for version v1alpha1 from group management in scope Integration", "operationId" : "patch_management_v1alpha1_Integration_Secret", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/secrets/{name}/{extension}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Secret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "description" : "Update Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Secret_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/secrets/{name}/languages" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Secret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for Secret for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Secret_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/secrets/{name}/languages-{code}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_Secret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for Secret for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_Secret_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/secrets" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "responses" : { "201" : { "description" : "Create a new Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/secrets/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing Secret for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed Secret for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/secrets/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Secret_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Secret_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/secrets/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Secret_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Secret_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/secrets/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the Secret", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_Secret_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_Secret_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for Secret for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/secrets" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Secret for version v1alpha1 from group catalog", "description" : "Retrieves Secret for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_Secret", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.Secret resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type Secret for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.Secret" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of Secret for version v1alpha1 from group catalog", "description" : "Retrieves a count of Secret for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_Secret", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of Secret for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of secrets." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/accesscontrollists" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "list_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "count_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope IdentityProvider.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Create AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "create_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Remove AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "remove_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group management in scope IdentityProvider. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group management in scope IdentityProvider" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Patch AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "patch_management_v1alpha1_IdentityProvider_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/identityproviders/{identityproviderName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "identityproviderName", "description" : "Name of the IdentityProvider", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "read_management_v1alpha1_IdentityProvider_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "operationId" : "update_management_v1alpha1_IdentityProvider_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope IdentityProvider", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/accesscontrollists" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management", "description" : "Retrieves AccessControlList for version v1alpha1 from group management", "operationId" : "list_management_v1alpha1_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management", "operationId" : "count_management_v1alpha1_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/documentresources/{documentresourceName}/accesscontrollists" : { "parameters" : [ { "name" : "documentresourceName", "description" : "Name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "list_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "count_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "create_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{documentresourceName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "documentresourceName", "description" : "Name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "read_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "remove_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope DocumentResource. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope DocumentResource" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "update_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "patch_catalog_v1alpha1_DocumentResource_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{documentresourceName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "documentresourceName", "description" : "Name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "read_catalog_v1alpha1_DocumentResource_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "update_catalog_v1alpha1_DocumentResource_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{documentresourceName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "documentresourceName", "description" : "Name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "read_catalog_v1alpha1_DocumentResource_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "update_catalog_v1alpha1_DocumentResource_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentresources/{documentresourceName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentresourceName", "description" : "Name of the DocumentResource", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "read_catalog_v1alpha1_DocumentResource_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "operationId" : "update_catalog_v1alpha1_DocumentResource_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentResource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/accesscontrollists" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog", "operationId" : "list_catalog_v1alpha1_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog", "operationId" : "count_catalog_v1alpha1_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/supportcontacts/{supportcontactName}/accesscontrollists" : { "parameters" : [ { "name" : "supportcontactName", "description" : "Name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "list_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "count_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SupportContact.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "create_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{supportcontactName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "supportcontactName", "description" : "Name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "read_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "remove_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope SupportContact. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope SupportContact" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "update_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "patch_catalog_v1alpha1_SupportContact_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{supportcontactName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "supportcontactName", "description" : "Name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "read_catalog_v1alpha1_SupportContact_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "update_catalog_v1alpha1_SupportContact_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{supportcontactName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "supportcontactName", "description" : "Name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "read_catalog_v1alpha1_SupportContact_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "update_catalog_v1alpha1_SupportContact_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/supportcontacts/{supportcontactName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "supportcontactName", "description" : "Name of the SupportContact", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "read_catalog_v1alpha1_SupportContact_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "operationId" : "update_catalog_v1alpha1_SupportContact_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope SupportContact", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/accesscontrollists" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "list_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Product", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "count_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Product.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "create_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "remove_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Product. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Product" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "patch_catalog_v1alpha1_Product_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/products/{productName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "productName", "description" : "Name of the Product", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "read_catalog_v1alpha1_Product_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "operationId" : "update_catalog_v1alpha1_Product_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{categoryName}/accesscontrollists" : { "parameters" : [ { "name" : "categoryName", "description" : "Name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "list_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Category", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "count_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Category.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "create_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{categoryName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "categoryName", "description" : "Name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "read_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "remove_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Category. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Category" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "update_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "patch_catalog_v1alpha1_Category_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{categoryName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "categoryName", "description" : "Name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "read_catalog_v1alpha1_Category_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "update_catalog_v1alpha1_Category_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{categoryName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "categoryName", "description" : "Name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "read_catalog_v1alpha1_Category_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "update_catalog_v1alpha1_Category_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/categories/{categoryName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "categoryName", "description" : "Name of the Category", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "read_catalog_v1alpha1_Category_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "operationId" : "update_catalog_v1alpha1_Category_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{apispeclintingrulesetName}/accesscontrollists" : { "parameters" : [ { "name" : "apispeclintingrulesetName", "description" : "Name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "list_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "count_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Create AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "create_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{apispeclintingrulesetName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "apispeclintingrulesetName", "description" : "Name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Remove AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "remove_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Update AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Patch AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "patch_management_v1alpha1_APISpecLintingRuleset_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{apispeclintingrulesetName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "apispeclintingrulesetName", "description" : "Name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{apispeclintingrulesetName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "apispeclintingrulesetName", "description" : "Name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/apispeclintingrulesets/{apispeclintingrulesetName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "apispeclintingrulesetName", "description" : "Name of the APISpecLintingRuleset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "read_management_v1alpha1_APISpecLintingRuleset_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "operationId" : "update_management_v1alpha1_APISpecLintingRuleset_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope APISpecLintingRuleset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/accesscontrollists" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "list_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "count_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Create AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "create_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Remove AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "remove_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Patch AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "patch_definitions_v1alpha1_ResourceGroup_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_AccessControlList_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_AccessControlList_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_AccessControlList_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_AccessControlList_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/groups/{groupName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "groupName", "description" : "Name of the ResourceGroup", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "read_definitions_v1alpha1_ResourceGroup_AccessControlList_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "operationId" : "update_definitions_v1alpha1_ResourceGroup_AccessControlList_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group definitions in scope ResourceGroup", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/accesscontrollists" : { "parameters" : [ { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group definitions", "description" : "Retrieves AccessControlList for version v1alpha1 from group definitions", "operationId" : "list_definitions_v1alpha1_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group definitions", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions", "operationId" : "count_definitions_v1alpha1_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } } }, "/catalog/v1alpha1/productplanunits/{productplanunitName}/accesscontrollists" : { "parameters" : [ { "name" : "productplanunitName", "description" : "Name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "list_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "count_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "create_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{productplanunitName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "productplanunitName", "description" : "Name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "remove_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "patch_catalog_v1alpha1_ProductPlanUnit_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{productplanunitName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "productplanunitName", "description" : "Name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{productplanunitName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "productplanunitName", "description" : "Name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplanunits/{productplanunitName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "productplanunitName", "description" : "Name of the ProductPlanUnit", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "read_catalog_v1alpha1_ProductPlanUnit_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "operationId" : "update_catalog_v1alpha1_ProductPlanUnit_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlanUnit", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/accesscontrollists" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "list_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "count_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "create_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "remove_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "patch_catalog_v1alpha1_DocumentTemplate_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documenttemplates/{documenttemplateName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "documenttemplateName", "description" : "Name of the DocumentTemplate", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "read_catalog_v1alpha1_DocumentTemplate_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "operationId" : "update_catalog_v1alpha1_DocumentTemplate_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentTemplate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/accesscontrollists" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "list_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "count_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "create_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "remove_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "patch_catalog_v1alpha1_DocumentCollection_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/documentcollections/{documentcollectionName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "documentcollectionName", "description" : "Name of the DocumentCollection", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "read_catalog_v1alpha1_DocumentCollection_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "operationId" : "update_catalog_v1alpha1_DocumentCollection_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope DocumentCollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{subscriptionrequestdefinitionName}/accesscontrollists" : { "parameters" : [ { "name" : "subscriptionrequestdefinitionName", "description" : "Name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "list_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "count_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "create_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{subscriptionrequestdefinitionName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "subscriptionrequestdefinitionName", "description" : "Name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "remove_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "patch_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{subscriptionrequestdefinitionName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "subscriptionrequestdefinitionName", "description" : "Name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{subscriptionrequestdefinitionName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "subscriptionrequestdefinitionName", "description" : "Name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptionrequestdefinitions/{subscriptionrequestdefinitionName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "subscriptionrequestdefinitionName", "description" : "Name of the SubscriptionRequestDefinition", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "read_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "operationId" : "update_catalog_v1alpha1_SubscriptionRequestDefinition_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope SubscriptionRequestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/accesscontrollists" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "list_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management in scope Integration", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "count_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Integration.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Create AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "create_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Remove AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "remove_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group management in scope Integration. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group management in scope Integration" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Update AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Patch AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "patch_management_v1alpha1_Integration_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/integrations/{integrationName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "integrationName", "description" : "Name of the Integration", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "read_management_v1alpha1_Integration_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "operationId" : "update_management_v1alpha1_Integration_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope Integration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/accesscontrollists" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "list_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "count_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Marketplace.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "create_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "remove_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Marketplace. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Marketplace" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "patch_catalog_v1alpha1_Marketplace_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/marketplaces/{marketplaceName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "marketplaceName", "description" : "Name of the Marketplace", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "read_catalog_v1alpha1_Marketplace_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "operationId" : "update_catalog_v1alpha1_Marketplace_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Marketplace", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{stageName}/accesscontrollists" : { "parameters" : [ { "name" : "stageName", "description" : "Name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "list_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Stage", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "count_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Stage.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "create_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{stageName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "stageName", "description" : "Name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "read_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "remove_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Stage. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Stage" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "update_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "patch_catalog_v1alpha1_Stage_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{stageName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "stageName", "description" : "Name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "read_catalog_v1alpha1_Stage_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "update_catalog_v1alpha1_Stage_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{stageName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "stageName", "description" : "Name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "read_catalog_v1alpha1_Stage_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "update_catalog_v1alpha1_Stage_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/stages/{stageName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "stageName", "description" : "Name of the Stage", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "read_catalog_v1alpha1_Stage_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "operationId" : "update_catalog_v1alpha1_Stage_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Stage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/accesscontrollists" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "list_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "count_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "create_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "remove_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope AssetRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope AssetRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "patch_catalog_v1alpha1_AssetRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assetreleases/{assetreleaseName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetreleaseName", "description" : "Name of the AssetRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "read_catalog_v1alpha1_AssetRelease_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "operationId" : "update_catalog_v1alpha1_AssetRelease_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope AssetRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{mcpclientName}/accesscontrollists" : { "parameters" : [ { "name" : "mcpclientName", "description" : "Name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "list_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "count_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope MCPClient.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "create_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{mcpclientName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "mcpclientName", "description" : "Name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "read_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "remove_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope MCPClient. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope MCPClient" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "update_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "patch_catalog_v1alpha1_MCPClient_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{mcpclientName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "mcpclientName", "description" : "Name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "read_catalog_v1alpha1_MCPClient_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "update_catalog_v1alpha1_MCPClient_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{mcpclientName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "mcpclientName", "description" : "Name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "read_catalog_v1alpha1_MCPClient_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "update_catalog_v1alpha1_MCPClient_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/mcpclients/{mcpclientName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "mcpclientName", "description" : "Name of the MCPClient", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "read_catalog_v1alpha1_MCPClient_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "operationId" : "update_catalog_v1alpha1_MCPClient_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope MCPClient", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/accesscontrollists" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "list_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "count_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "create_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "remove_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope ProductRelease. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope ProductRelease" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "patch_catalog_v1alpha1_ProductRelease_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productreleases/{productreleaseName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "productreleaseName", "description" : "Name of the ProductRelease", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "read_catalog_v1alpha1_ProductRelease_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "operationId" : "update_catalog_v1alpha1_ProductRelease_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductRelease", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{watchtopicName}/accesscontrollists" : { "parameters" : [ { "name" : "watchtopicName", "description" : "Name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "list_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management in scope WatchTopic", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "count_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope WatchTopic.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Create AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "create_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{watchtopicName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "watchtopicName", "description" : "Name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "read_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Remove AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "remove_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group management in scope WatchTopic. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group management in scope WatchTopic" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Update AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "update_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Patch AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "patch_management_v1alpha1_WatchTopic_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{watchtopicName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "watchtopicName", "description" : "Name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "read_management_v1alpha1_WatchTopic_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "update_management_v1alpha1_WatchTopic_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{watchtopicName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "watchtopicName", "description" : "Name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "read_management_v1alpha1_WatchTopic_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "update_management_v1alpha1_WatchTopic_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/watchtopics/{watchtopicName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "watchtopicName", "description" : "Name of the WatchTopic", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "read_management_v1alpha1_WatchTopic_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "operationId" : "update_management_v1alpha1_WatchTopic_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope WatchTopic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/accesscontrollists" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "list_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "count_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "create_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "remove_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope ProductPlan. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope ProductPlan" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "patch_catalog_v1alpha1_ProductPlan_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/productplans/{productplanName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "productplanName", "description" : "Name of the ProductPlan", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "read_catalog_v1alpha1_ProductPlan_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "operationId" : "update_catalog_v1alpha1_ProductPlan_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope ProductPlan", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/accesscontrollists" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "list_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Application", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "count_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Application.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "create_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "remove_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Application. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Application" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "patch_catalog_v1alpha1_Application_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/applications/{applicationName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "applicationName", "description" : "Name of the Application", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "read_catalog_v1alpha1_Application_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "operationId" : "update_catalog_v1alpha1_Application_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{componentName}/accesscontrollists" : { "parameters" : [ { "name" : "componentName", "description" : "Name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "list_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group definitions in scope Component", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "count_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group definitions in scope Component.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Create AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "create_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{componentName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "componentName", "description" : "Name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "read_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Remove AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "remove_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group definitions in scope Component. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group definitions in scope Component" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "update_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Patch AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "patch_definitions_v1alpha1_Component_AccessControlList", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{componentName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "componentName", "description" : "Name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "read_definitions_v1alpha1_Component_AccessControlList_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "update_definitions_v1alpha1_Component_AccessControlList_extension", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{componentName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "componentName", "description" : "Name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "read_definitions_v1alpha1_Component_AccessControlList_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "update_definitions_v1alpha1_Component_AccessControlList_languages", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/definitions/v1alpha1/components/{componentName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "componentName", "description" : "Name of the Component", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "read_definitions_v1alpha1_Component_AccessControlList_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "operationId" : "update_definitions_v1alpha1_Component_AccessControlList_languages_code", "tags" : [ "definitions" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the definitions.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group definitions in scope Component", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/definitions.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accesscontrollists" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "list_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group management in scope Environment", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "count_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.definition.lintingType * scopeResource.status.level * scopeResource.spec.axwayManaged\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group management in scope Environment.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Create AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "create_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Remove AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "remove_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group management in scope Environment. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group management in scope Environment" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Update AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Patch AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "patch_management_v1alpha1_Environment_AccessControlList", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessControlList_extension", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessControlList_languages", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/management/v1alpha1/environments/{environmentName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "environmentName", "description" : "Name of the Environment", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "read_management_v1alpha1_Environment_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "operationId" : "update_management_v1alpha1_Environment_AccessControlList_languages_code", "tags" : [ "management" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the management.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group management in scope Environment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/management.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/accesscontrollists" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "list_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Asset", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "count_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Asset.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "create_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "remove_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Asset. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Asset" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "patch_catalog_v1alpha1_Asset_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/assets/{assetName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "assetName", "description" : "Name of the Asset", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "read_catalog_v1alpha1_Asset_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "operationId" : "update_catalog_v1alpha1_Asset_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Asset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/accesscontrollists" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "list_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "count_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "create_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "remove_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "patch_catalog_v1alpha1_AuthorizationProfile_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/authprofiles/{authprofileName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "authprofileName", "description" : "Name of the AuthorizationProfile", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "read_catalog_v1alpha1_AuthorizationProfile_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "operationId" : "update_catalog_v1alpha1_AuthorizationProfile_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope AuthorizationProfile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/accesscontrollists" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "list_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/pageNumberParam" }, { "$ref" : "#/components/parameters/pageSizeParam" }, { "$ref" : "#/components/parameters/sortParam" }, { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.scope.id * metadata.scope.name * metadata.scope.kind * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource. * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope. * referencedResources.* - Provides access to properties belong to referenced resources. * referencedByResources.* - Provides access to properties belong to resources referencing this resource. * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List all resources of type AccessControlList for version v1alpha1 from group catalog in scope Subscription", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "head" : { "summary" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "count_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources: * name * title * tags * attributes * metadata.id * metadata.state * metadata.references.id * metadata.references.kind * metadata.references.name * metadata.deletedReferences.id * metadata.deletedReferences.kind * metadata.deletedReferences.name * metadata.resourceVersion * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd\\'T\\'HH:mm:ss.SSSZZZZ * scopeResource.spec.usage.useAsDefault * scopeResource.spec.data.contentType * scopeResource.spec.parentCategory * scopeResource.spec.data.fileName * scopeResource.spec.state * scopeResource.approval.previousState * scopeResource.state.name * scopeResource.spec.usage.kind * scopeResource.state * scopeResource.state.when.timestamp * scopeResource.spec.versionProperties.label * scopeResource.spec.usage.apiServices.available * scopeResource.spec.restriction.marketplace.visible * scopeResource.spec.version * scopeResource.marketplace.resource.owner.organization.id * scopeResource.approval.state * scopeResource.spec.data.type * scopeResource.marketplace.resource.owner.id * scopeResource.spec.usage.enforced * scopeResource.references.platformSettings.used * scopeResource.spec.usage.products.available * scopeResource.spec.usage.marketplaceSettings.available * scopeResource.spec.restriction.type * scopeResource.billing.payment.type * scopeResource.marketplace.resource.owner.user.id * scopeResource.status.level * scopeResource.spec.type * scopeResource.spec.data.fileType * scopeResource.spec.restriction.marketplace.featured * scopeResource.billing.type * scopeResource.spec.usage.mcpClients.available\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters", "required" : false, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "description" : "Set to \"all\" to fetch a count of all resources, including resources you do not have access to. Set to \"accessible\" to fetch a count resources you have access to, which is the default if not specified. Unknown values will return a bad request (400) status code.", "required" : false, "schema" : { "type" : "string", "enum" : [ "accessible", "all" ] } } ], "responses" : { "200" : { "description" : "Retrieves a count of AccessControlList for version v1alpha1 from group catalog in scope Subscription.", "headers" : { "X-Axway-Total-Count" : { "schema" : { "type" : "integer" }, "description" : "Total number of accesscontrollists." } } }, "400" : { "description" : "Failed to validate request parameters." }, "401" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate." }, "403" : { "description" : "Forbidden, the user does not have the correct permissions to call this API." }, "404" : { "description" : "The resource kind specified in the path could not be found." }, "500" : { "description" : "Unexpected internal server error." } } }, "post" : { "summary" : "Create AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Create AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "create_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "201" : { "description" : "Create a new AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/accesscontrollists/{name}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "delete" : { "summary" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Remove AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "remove_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/forceRemovalParam" } ], "responses" : { "202" : { "description" : "Accepted removing AccessControlList for version v1alpha1 from group catalog in scope Subscription. Dependent resources found, clean up will finish once all dependent resources have been removed" }, "204" : { "description" : "Removed AccessControlList for version v1alpha1 from group catalog in scope Subscription" }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "patch" : { "summary" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Patch AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "patch_catalog_v1alpha1_Subscription_AccessControlList", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec, {extension}, languages, languages-{code}. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json-patch+json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.JsonPatchList" } } } }, "responses" : { "200" : { "description" : "Update AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/accesscontrollists/{name}/{extension}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "extension", "description" : "Name of the extension", "in" : "path", "schema" : { "type" : "string", "pattern" : "x-.*" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_AccessControlList_extension", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Extension resource data of AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/accesscontrollists/{name}/languages" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_AccessControlList_languages", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } }, "/catalog/v1alpha1/subscriptions/{subscriptionName}/accesscontrollists/{name}/languages-{code}" : { "parameters" : [ { "name" : "subscriptionName", "description" : "Name of the Subscription", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "name" : "code", "description" : "Language code.", "in" : "path", "schema" : { "type" : "string", "pattern" : "^(en-us|pt-br|de-de|fr-fr)$" }, "required" : true }, { "name" : "name", "description" : "The name of the AccessControlList", "in" : "path", "schema" : { "type" : "string" }, "required" : true }, { "$ref" : "#/components/parameters/TenantHeader" } ], "get" : { "summary" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Retrieves Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "read_catalog_v1alpha1_Subscription_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "$ref" : "#/components/parameters/resourceLanguageCodeParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Read Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } }, "put" : { "summary" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "description" : "Update Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "operationId" : "update_catalog_v1alpha1_Subscription_AccessControlList_languages_code", "tags" : [ "catalog" ], "parameters" : [ { "$ref" : "#/components/parameters/embedParam" }, { "$ref" : "#/components/parameters/expandParam" }, { "name" : "fields", "in" : "query", "description" : "Query string for restricting the response fields from the catalog.v1alpha1.AccessControlList resource. Multiple values can be specified separated by comma. Supported values: group, apiVersion, kind, name, title, metadata, attributes, tags, spec. Unknown values will be ignored.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "responses" : { "200" : { "description" : "Updated Languages data for AccessControlList for version v1alpha1 from group catalog in scope Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/catalog.v1alpha1.AccessControlList" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "428" : { "$ref" : "#/components/responses/PreConditionRequired" }, "500" : { "$ref" : "#/components/responses/InternalServerError" } } } } }, "components" : { "parameters" : { "pageNumberParam" : { "name" : "page", "in" : "query", "description" : "The offset starting page number in the result set to start returning results from, starts at 1.", "required" : false, "schema" : { "type" : "integer", "default" : 1 } }, "pageSizeParam" : { "name" : "pageSize", "in" : "query", "description" : "The number of entities allowed in a page.", "required" : false, "schema" : { "type" : "integer", "default" : 20 } }, "sortParam" : { "name" : "sort", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } }, "description" : "The field to sort result sets by, in ASC or DESC order.\nAllowed fields for sorting:\n * name\n * title\n * metadata.audit.createTimestamp\n * metadata.audit.modifyTimestamp\n * metadata.scope.title (usable when listing resources across multiple scopes)\n" }, "queryParam" : { "name" : "query", "in" : "query", "description" : "Query string for filtering entity. Expressed in FIQL/RSQL language. Supported filters on resources:\n * name\n * title\n * tags\n * attributes\n * metadata.id\n * metadata.scope.id\n * metadata.scope.name\n * metadata.scope.kind\n * metadata.references.id\n * metadata.references.kind\n * metadata.references.name\n * metadata.deletedReferences.id\n * metadata.deletedReferences.kind\n * metadata.deletedReferences.name\n * metadata.resourceVersion\n * metadata.audit.createTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd'T'HH:mm:ss.SSSZZZZ\n * metadata.audit.modifyTimestamp - Date filter must be provided as epoch time or yyyy-MM-dd'T'HH:mm:ss.SSSZZZZ\n * metadata.scope.owner.id\n * owner.id\n * scopedResources.* - Only valid for unscoped resources. Filters based on properties belonging to scoped resource.\n * scopeResource.* - Only valid for scoped resources. Filter with properties belonging to the scope.\n * referencedResources.* - Provides access to properties belong to referenced resources.\n * referencedByResources.* - Provides access to properties belong to resources referencing this resource.\n\nDocumentation link: https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/cli_command_reference/index.html#complex-query-filters\n", "required" : false, "schema" : { "type" : "string" } }, "embedParam" : { "name" : "embed", "in" : "query", "description" : "Defines parameters that can be embedded:\n * metadata.references - includes the referenced resources in the response.\n * metadata.accessRights.canCreateScoped - includes user's permissions on requested resource and its scope.\n * metadata.referencedByResources - includes counts for the resources referencing the current resource.\n * metadata.scopedResources - includes counts for the resources scoped to the current resource.\n", "required" : false, "schema" : { "type" : "string" } }, "expandParam" : { "name" : "expand", "in" : "query", "description" : "Defines parameters that can be expanded:\n * languages - expands the languages in the response.\n * languages-* - expands the additional languages (\"en-us\", \"pt-br\", \"de-de\", \"fr-fr\")\n", "required" : false, "schema" : { "type" : "string" } }, "resourceLanguageCodeParam" : { "name" : "resource.language.code", "in" : "query", "description" : "Defines in which language(\"en-us\", \"pt-br\", \"de-de\", \"fr-fr\") the resource is retrieved. If the requested language does not exist or a property in that language was not internationalized, the resource default language value will be returned.\n", "required" : false, "schema" : { "type" : "string" } }, "forceRemovalParam" : { "name" : "forceDelete", "in" : "query", "description" : "If set to true, finalizers will get reset as part of the resources cleanup process. Use with caution!\n", "required" : false, "schema" : { "type" : "boolean" } }, "TenantHeader" : { "name" : "X-Axway-Tenant-Id", "in" : "header", "schema" : { "type" : "string", "maxLength" : 36 }, "required" : false, "description" : "The platform Organization ID. Not required when using Service Accounts." } }, "responses" : { "BadRequest" : { "description" : "Failed to validate request parameters.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "Unauthorized" : { "description" : "Unauthorized. A valid authorization header was not provided with the request to authenticate.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "Forbidden" : { "description" : "Forbidden, the user does not have the correct permissions to call this API.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "NotFound" : { "description" : "The resource specified could not be found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "Conflict" : { "description" : "Request conflicts with the current state of the server.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "PreConditionRequired" : { "description" : "The update Request is out of Sync with database.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } }, "InternalServerError" : { "description" : "Unexpected internal server error.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api.v1.ErrorResponse" } } } } }, "securitySchemes" : { "BearerToken" : { "type" : "http", "scheme" : "bearer", "description" : "Authenticated platform bearer token." }, "OAuth2" : { "type" : "oauth2", "flows" : { "clientCredentials" : { "tokenUrl" : "https://login.axway.com/auth/realms/Broker/protocol/openid-connect/token", "scopes" : { } }, "authorizationCode" : { "authorizationUrl" : "https://login.axway.com/auth/realms/Broker/protocol/openid-connect/auth", "tokenUrl" : "https://login.axway.com/auth/realms/Broker/protocol/openid-connect/token", "scopes" : { } }, "implicit" : { "authorizationUrl" : "https://login.axway.com/auth/realms/Broker/protocol/openid-connect/auth", "scopes" : { } } } } }, "schemas" : { "api.v1.ErrorResponse" : { "title" : "api.v1.ErrorResponse", "description" : "Detail for standard error responses.", "type" : "object", "additionalProperties" : true, "properties" : { "errors" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : true, "properties" : { "status" : { "type" : "integer" }, "title" : { "type" : "string" }, "detail" : { "type" : "string" }, "meta" : { "type" : "object", "additionalProperties" : true, "properties" : { "tenantId" : { "type" : "string" } } } } } } } }, "api.v1.EmbeddedReferencedByResource" : { "type" : "object", "properties" : { "kind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the resource." }, "scopeKind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the scope resource where the resource is defined." }, "group" : { "type" : "string", "maxLength" : 80, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "Defines the group from which the resource belongs to." }, "count" : { "type" : "integer", "description" : "Number of resources." }, "link" : { "type" : "string", "description" : "The link that can be used to access those referencing resources." } } }, "api.v1.EmbeddedScopedResources" : { "type" : "object", "properties" : { "kind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the resource." }, "count" : { "type" : "integer", "description" : "Number of resources." }, "link" : { "type" : "string", "description" : "The link that can be used to access those resources." } } }, "api.v1.EmbeddedReference" : { "type" : "object", "properties" : { "group" : { "type" : "string", "maxLength" : 80, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "Defines the group from which the resource belongs to." }, "apiVersion" : { "type" : "string", "maxLength" : 20, "description" : "Defines the api version of the resource." }, "kind" : { "type" : "string", "maxLength" : 30, "description" : "Defines the kind of the resource. The server infers this from the endpoint the client submits the request to." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*" }, "title" : { "type" : "string", "maxLength" : 350 }, "metadata" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Internal id of the resource." }, "accessRights" : { "type" : "object", "properties" : { "canChangeOwner" : { "type" : "boolean", "description" : "Defines if the current user can change the owner of the resource." }, "canDelete" : { "type" : "boolean", "description" : "Defines if the current user can delete the resource." }, "canWrite" : { "type" : "boolean", "description" : "Defines if the current user can update the resource." }, "canRead" : { "type" : "boolean", "description" : "Defines if the current user can read the resource." } } }, "selfLink" : { "type" : "string", "description" : "The URL representing the scope resource object." } } } } }, "api.v1.Embedded" : { "type" : "object", "description" : "Embedded information attached to the resource if the embed request parameters are used", "properties" : { "metadata" : { "type" : "object", "properties" : { "referencedByResources" : { "description" : "Provides details on resources referencing the current resource. Included if embed parameter contains referencedByResources.", "type" : "array", "items" : { "$ref" : "#/components/schemas/api.v1.EmbeddedReferencedByResource" } }, "scopedResources" : { "type" : "array", "description" : "Provides information about resources scoped to the current resource. Included if embed parameter contains metadata.scopedResources.", "items" : { "$ref" : "#/components/schemas/api.v1.EmbeddedScopedResources" } }, "references" : { "description" : "Provides additional information about the resources being referenced by the current resource. Included if embed parameter contains metadata.references.", "type" : "array", "items" : { "$ref" : "#/components/schemas/api.v1.EmbeddedReference" } } } } } }, "api.v1.Metadata" : { "type" : "object", "description" : "Metadata that all server resources have. Data is generated by the server.", "properties" : { "id" : { "type" : "string", "description" : "Internal id of the resource." }, "audit" : { "$ref" : "#/components/schemas/api.v1.AuditMetadata" }, "scope" : { "type" : "object", "description" : "The scope where this resource was defined.", "properties" : { "id" : { "type" : "string", "maxLength" : 32, "description" : "Internal id of the scope resource where the resource is defined." }, "kind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the scope resource where the resource is defined." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "The name of the scope where the resource is defined." }, "title" : { "type" : "string", "maxLength" : 350, "description" : "The title of the scope where the resource is defined." }, "selfLink" : { "type" : "string", "description" : "The URL representing the scope resource object." }, "owner" : { "$ref" : "#/components/schemas/api.v1.Owner" } } }, "acls" : { "type" : "array", "description" : "Access Control Lists for this resource.", "items" : { "$ref" : "#/components/schemas/api.v1.Acl" } }, "resourceVersion" : { "type" : "string", "description" : "Internal version of this object that can be used by clients to determine when objects have changed.", "maxLength" : 20 }, "references" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/api.v1.Reference" } }, "deletedReferences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/api.v1.Reference" } }, "state" : { "type" : "string", "description" : "Defines the state of the resource. If present, indicates if the resource is in Deleting state." }, "selfLink" : { "type" : "string", "description" : "The URL representing this resource object." } }, "readOnly" : true }, "api.v1.Reference" : { "type" : "object", "description" : "List of objects dependent by this object.", "properties" : { "id" : { "type" : "string", "maxLength" : 32, "description" : "Unique id generated by the server." }, "kind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the referenced resource." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "The name of the referenced resource." }, "scopeKind" : { "type" : "string", "maxLength" : 30, "description" : "The kind of the referenced resource scope." }, "scopeName" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "The name of the referenced resource scope." }, "selfLink" : { "type" : "string", "description" : "The URL representing the referenced resource." }, "type" : { "type" : "string", "default" : "hard", "description" : "Defines the type of the reference: * soft - spec property that has this reference will get nulled out if the referenced resource gets removed. * hard - dictates that the current resource will get removed when the referenced resource gets removed.\n", "enum" : [ "soft", "hard" ] } }, "readOnly" : true }, "api.v1.Language" : { "type" : "object", "description" : "Defines information about a specific language defined on the resource.", "properties" : { "metadata" : { "type" : "object", "description" : "Information about resource languages", "properties" : { "code" : { "type" : "string", "description" : "Language code.", "x-extensible-enum" : [ "en-en", "fr-fr", "de-de", "pt-br", "undefined" ] }, "status" : { "type" : "string", "description" : "Status of the language. * \"complete\" language available for the resource with no missing properties or properties that need to be reviewed. * \"toReview\" language has properties that are missing or need to be reviewed. * \"undefined\" language is not defined on the resource.\n", "enum" : [ "complete", "toReview", "undefined" ] }, "paths" : { "type" : "object", "description" : "Defines the paths that are not complete if the status of the language is \"toReview\"", "properties" : { "toReview" : { "type" : "array", "description" : "The paths for the language that are in \"toReview\" status.", "items" : { "type" : "string" } }, "undefined" : { "type" : "array", "description" : "The paths for the language that are in \"undefined\" status.", "items" : { "type" : "string" } } } }, "audit" : { "$ref" : "#/components/schemas/api.v1.AuditMetadata" } } }, "values" : { "description" : "Defines the language specific values set on the resource.", "type" : "array", "items" : { "type" : "object", "properties" : { "path" : { "type" : "string", "description" : "The json path for where the value is defined" }, "value" : { "type" : "object", "description" : "The value" }, "status" : { "type" : "string", "description" : "Status of the value for the path. * \"complete\" value provided and does not need to be reviewed. * \"toReview\" value provided, but it needs to be reviewed. * \"undefined\" value not provided.\n", "enum" : [ "complete", "toReview", "undefined" ] } } } } } }, "api.v1.Languages" : { "type" : "object", "description" : "Defines information about the supported languages on the resource.", "properties" : { "resource" : { "type" : "object", "description" : "Provides information about the default language in which the resource was defined", "required" : [ "code" ], "properties" : { "code" : { "type" : "string", "description" : "Language code.", "x-extensible-enum" : [ "en-us", "fr-fr", "de-de", "pt-br", "undefined" ] } } }, "metadata" : { "type" : "object", "description" : "Information about resource languages", "properties" : { "additional" : { "type" : "array", "description" : "Additional languages available for the resource instance.", "items" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Language code.", "x-extensible-enum" : [ "en-us", "fr-fr", "de-de", "pt-br", "undefined" ] }, "status" : { "type" : "string", "description" : "Status of the language. * \"complete\" language available for the resource with no missing properties or properties that need to be reviewed. * \"toReview\" language has properties that are missing or need to be reviewed. * \"undefined\" language was set initially and removed later.\n", "enum" : [ "complete", "toReview", "undefined" ] } } } }, "audit" : { "$ref" : "#/components/schemas/api.v1.AuditMetadata" } } } } }, "api.v1.Acl" : { "type" : "object", "description" : "Summarizes an Access Control List (ACL) resource associated with an API Server resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 32, "description" : "Unique id generated by the server." }, "subjectType" : { "type" : "string", "default" : "team", "description" : "Type of the subject.", "enum" : [ "team" ] }, "subjectId" : { "type" : "string", "maxLength" : 36, "description" : "UUID of the subject." }, "aclId" : { "type" : "string", "maxLength" : 36, "description" : "ID of the ACL Resource." } } }, "api.v1.AuditMetadata" : { "title" : "api.v1.AuditMetadata", "description" : "Read-only metadata for the record.", "properties" : { "createTimestamp" : { "type" : "string", "format" : "date-time", "description" : "The creation time in ISO 8601 format with numeric timezone offset.", "example" : "2025-05-14T12:34:56.789+0000" }, "createUserId" : { "type" : "string", "description" : "Id of the user that created the entity.", "minLength" : 1, "maxLength" : 52 }, "modifyTimestamp" : { "type" : "string", "format" : "date-time", "description" : "The last modification time in ISO 8601 format with numeric timezone offset.", "example" : "2025-05-14T12:34:56.789+0000" }, "modifyUserId" : { "type" : "string", "description" : "Id of the user that last modified the entity.", "minLength" : 1, "maxLength" : 52 } }, "readOnly" : true, "type" : "object" }, "api.v1.Attributes" : { "title" : "api.v1.Attributes", "description" : "Custom attributes added to objects.", "type" : "object", "additionalProperties" : { "type" : "string", "nullable" : false } }, "api.v1.Finalizer" : { "description" : "Finalizer on the API server resource.", "type" : "object", "properties" : { "name" : { "type" : "string", "minLength" : 1, "maxLength" : 100 }, "description" : { "type" : "string", "maxLength" : 350 } }, "required" : [ "name" ] }, "api.v1.Owner" : { "description" : "Owner of the resource.", "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the owner. Defaults to team if not present.", "enum" : [ "team" ], "default" : "team" }, "id" : { "type" : "string", "description" : "Id of the owner of the resource.", "maxLength" : 36 } }, "required" : [ "id" ] }, "api.v1.JsonPatchList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/api.v1.JsonPatch" } }, "api.v1.JsonPatch" : { "type" : "object", "description" : "Json Patch for the API Server resource.", "properties" : { "op" : { "type" : "string", "description" : "The patch operation to perform: * add - Adds or replaces a property with the given value. * replace - Replaces an existing property with the given value. Throws an error if property does not exist. * remove - Removes the property. Throws an error if the property does not exist. * x-build-object-tree - Adds object properties for each segment in the path if they don't already exist.\n", "enum" : [ "add", "replace", "remove", "x-build-object-tree" ] }, "path" : { "type" : "string" }, "value" : { "type" : "object" } }, "required" : [ "op", "path" ] }, "api.v1.ResourceInstance" : { "description" : "API Server generic resource structure.", "properties" : { "group" : { "type" : "string", "maxLength" : 80, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "Defines the group from which the resource belongs to. The server infers this from the endpoint the client submits the request to." }, "apiVersion" : { "type" : "string", "maxLength" : 20, "description" : "Defines the structure of the resource. The server infers this from the endpoint the client submits the request to." }, "kind" : { "type" : "string", "maxLength" : 30, "description" : "Defines the kind of the resource. The server infers this from the endpoint the client submits the request to." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*" }, "title" : { "type" : "string", "maxLength" : 350 }, "metadata" : { "$ref" : "#/components/schemas/api.v1.Metadata" }, "attributes" : { "$ref" : "#/components/schemas/api.v1.Attributes" }, "finalizers" : { "type" : "array", "description" : "Adding finalizers to a resource tells the system to wait until specific conditions are met before it fully deletes the resource. Deleting a resource that has finalizers alerts controllers, agents and resource hooks, allowing them to clean up local objects the deleted resource owned. When you delete a resource that has finalizers specified, the resource will move to a \\\"DELETING\\\" state but removal of the resource will not complete until all the finalizers are removed. Finalizers can be used to ensure consistency between a dataplane and management plane. If the dataplane has allocated entities that need to be garbage collected when the resource is deleted they can listen for the state change events. Once the dataplane is finished with its clean up it removes the finalizer from the resource, allowing to proceed with the removal of the resource. To remove resources without being blocked by finalizers, if they are present on the resource, look into using 'forceDelete' request parameter.\n", "items" : { "$ref" : "#/components/schemas/api.v1.Finalizer" } }, "owner" : { "$ref" : "#/components/schemas/api.v1.Owner" }, "tags" : { "type" : "array", "description" : "List of tags.", "items" : { "type" : "string", "minLength" : 1, "maxLength" : 80 } }, "spec" : { "type" : "object", "description" : "Resource instance specs." }, "_embedded" : { "$ref" : "#/components/schemas/api.v1.Embedded" } }, "additionalProperties" : { "type" : "object" }, "required" : [ "spec" ] }, "management.v1alpha1.WatchTopic" : { "description" : "Definition of WatchTopic for version v1alpha1 in group management. \n\n Resource representing a set of filters for the Agents to create a GRPC Watch stream", "type" : "object", "x-axway-group" : "management", "x-axway-version" : "v1alpha1", "x-axway-kind" : "WatchTopic", "x-axway-plural" : "watchtopics", "x-axway-scoped" : false, "x-axway-references" : { "fromResources" : [ ], "toResources" : [ ] }, "properties" : { "group" : { "type" : "string", "maxLength" : 80, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "readOnly" : true, "description" : "Resource belongs to the management group. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "management" }, "apiVersion" : { "type" : "string", "maxLength" : 20, "readOnly" : true, "description" : "Resource version is v1alpha1. The version defines the structure of the resource. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "v1alpha1" }, "kind" : { "type" : "string", "maxLength" : 30, "readOnly" : true, "description" : "Resource of kind WatchTopic. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "WatchTopic" }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "Name of the WatchTopic. WatchTopic name is unique and cannot be updated. The characters allowed in names are: digits (0-9), lower case letters (a-z), -, and ." }, "title" : { "type" : "string", "maxLength" : 350, "description" : "The friendly name of the WatchTopic." }, "metadata" : { "$ref" : "#/components/schemas/api.v1.Metadata" }, "owner" : { "$ref" : "#/components/schemas/api.v1.Owner" }, "finalizers" : { "type" : "array", "description" : "Adding finalizers to a resource tells the system to wait until specific conditions are met before it fully deletes the resource. Deleting a resource that has finalizers alerts controllers, agents and resource hooks, allowing them to clean up local objects the deleted resource owned. When you delete a resource that has finalizers specified, the resource will move to a \"DELETING\" state but removal of the resource will not complete until all the finalizers are removed. Finalizers can be used to ensure consistency between a dataplane and management plane. If the dataplane has allocated entities that need to be garbage collected when the resource is deleted they can listen for the state change events. Once the dataplane is finished with its clean up it removes the finalizer from the resource, allowing to proceed with the removal of the resource. To remove resources without being blocked by finalizers, if they are present on the resource, look into using 'forceDelete' request parameter.", "items" : { "$ref" : "#/components/schemas/api.v1.Finalizer" } }, "attributes" : { "$ref" : "#/components/schemas/api.v1.Attributes" }, "tags" : { "type" : "array", "description" : "List of tags.", "items" : { "type" : "string", "minLength" : 1, "maxLength" : 80 } }, "spec" : { "$ref" : "#/components/schemas/management.v1alpha1.WatchTopicSpec" }, "languages" : { "$ref" : "#/components/schemas/api.v1.Languages" }, "languages-en-us" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-pt-br" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-de-de" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-fr-fr" : { "$ref" : "#/components/schemas/api.v1.Language" }, "_embedded" : { "$ref" : "#/components/schemas/api.v1.Embedded" } }, "required" : [ "spec" ] }, "management.v1alpha1.WatchTopicSpec" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description of the WatchTopic", "maxLength" : 350 }, "filters" : { "type" : "array", "minItems" : 1, "items" : { "type" : "object", "properties" : { "group" : { "type" : "string", "maxLength" : 30, "description" : "Value for the group of the resource. Use \"*\" for any." }, "scope" : { "type" : "object", "description" : "Resource scope filter details.", "properties" : { "kind" : { "type" : "string", "maxLength" : 30, "description" : "Value for the Kind of the scope of the resource. Use \"*\" for any." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^([\\*])|([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)", "description" : "Name of the scope of the resource. Use \"*\" for any." } }, "additionalProperties" : false, "required" : [ "kind", "name" ] }, "kind" : { "type" : "string", "maxLength" : 30, "description" : "Value for the Kind of the resource. Use \"*\" for any." }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^([\\*])|([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)", "description" : "Name of the resource. Use \"*\" for any." }, "type" : { "type" : "array", "minItems" : 1, "items" : { "type" : "string", "description" : "Type of the operation for the tracked resources.", "enum" : [ "created", "updated", "deleted" ] } } }, "required" : [ "group", "kind", "name", "type" ] } } }, "required" : [ "filters" ], "additionalProperties" : false }, "management.v1alpha1.DiscoveryAgent" : { "description" : "Definition of DiscoveryAgent for version v1alpha1 in group management. \n\n Resource representing a discovery agent", "type" : "object", "x-axway-group" : "management", "x-axway-version" : "v1alpha1", "x-axway-kind" : "DiscoveryAgent", "x-axway-plural" : "discoveryagents", "x-axway-scoped" : true, "x-axway-subresources" : [ "status", "agentstate", "dataplane" ], "x-axway-scopes" : [ { "kind" : "Environment", "plural" : "environments" } ], "x-axway-references" : { "fromResources" : [ ], "toResources" : [ { "group" : "management", "kind" : "Dataplane", "scopeKind" : "Environment", "plural" : "dataplanes", "versions" : [ "v1alpha1" ], "types" : [ "SOFT" ] } ] }, "properties" : { "group" : { "type" : "string", "maxLength" : 80, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "readOnly" : true, "description" : "Resource belongs to the management group. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "management" }, "apiVersion" : { "type" : "string", "maxLength" : 20, "readOnly" : true, "description" : "Resource version is v1alpha1. The version defines the structure of the resource. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "v1alpha1" }, "kind" : { "type" : "string", "maxLength" : 30, "readOnly" : true, "description" : "Resource of kind DiscoveryAgent. Cannot be updated. The server infers this from the endpoint the client submits the request to.", "default" : "DiscoveryAgent" }, "name" : { "type" : "string", "maxLength" : 100, "pattern" : "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*", "description" : "Name of the DiscoveryAgent. DiscoveryAgent name is unique and cannot be updated. The characters allowed in names are: digits (0-9), lower case letters (a-z), -, and ." }, "title" : { "type" : "string", "maxLength" : 350, "description" : "The friendly name of the DiscoveryAgent." }, "metadata" : { "$ref" : "#/components/schemas/api.v1.Metadata" }, "owner" : { "$ref" : "#/components/schemas/api.v1.Owner" }, "finalizers" : { "type" : "array", "description" : "Adding finalizers to a resource tells the system to wait until specific conditions are met before it fully deletes the resource. Deleting a resource that has finalizers alerts controllers, agents and resource hooks, allowing them to clean up local objects the deleted resource owned. When you delete a resource that has finalizers specified, the resource will move to a \"DELETING\" state but removal of the resource will not complete until all the finalizers are removed. Finalizers can be used to ensure consistency between a dataplane and management plane. If the dataplane has allocated entities that need to be garbage collected when the resource is deleted they can listen for the state change events. Once the dataplane is finished with its clean up it removes the finalizer from the resource, allowing to proceed with the removal of the resource. To remove resources without being blocked by finalizers, if they are present on the resource, look into using 'forceDelete' request parameter.", "items" : { "$ref" : "#/components/schemas/api.v1.Finalizer" } }, "attributes" : { "$ref" : "#/components/schemas/api.v1.Attributes" }, "tags" : { "type" : "array", "description" : "List of tags.", "items" : { "type" : "string", "minLength" : 1, "maxLength" : 80 } }, "spec" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgentSpec" }, "status" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgentStatus" }, "agentstate" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgentAgentstate" }, "dataplane" : { "$ref" : "#/components/schemas/management.v1alpha1.DiscoveryAgentDataplane" }, "languages" : { "$ref" : "#/components/schemas/api.v1.Languages" }, "languages-en-us" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-pt-br" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-de-de" : { "$ref" : "#/components/schemas/api.v1.Language" }, "languages-fr-fr" : { "$ref" : "#/components/schemas/api.v1.Language" }, "_embedded" : { "$ref" : "#/components/schemas/api.v1.Embedded" } }, "required" : [ "spec" ] }, "management.v1alpha1.DiscoveryAgentSpec" : { "type" : "object", "properties" : { "dataplaneType" : { "type" : "string", "description" : "The dataplane type that this agent connects to", "maxLength" : 255, "x-amplify-index" : { }, "x-amplify-event-data" : { }, "x-extensible-enum" : [ "APIConnect", "APIM", "Apigee", "ApigeeX", "AWS", "Azure", "Backstage", "GitHub", "GitLab", "Istio", "Kafka", "Kong", "Mulesoft", "SAPAPIPortal", "Sensedia", "SwaggerHub", "WebMethods", "WSO2", "Unidentified", "Unclassified" ] }, "config" : { "type" : "object", "description" : "Represents the discovery agent config", "properties" : { "filter" : { "type" : "string", "description" : "Defines the tag based filter expression to be evaluated for discovering the API from the API Gateway. The filter value is a conditional expression that can use logical operators to compare two value. The conditional expression must have \"tag\" as the prefix/selector in the symbol name. For e.g.\n``` tag.SOME_TAG == \"somevalue\" ```\nThe expression can be a simple condition as shown above or compound condition in which more than one simple conditions are evaluated using logical operator.\nFor e.g.\n``` tag.SOME_TAG == \"somevalue\" || tag.ANOTHER_TAG != \"some_other_value\" ```\nIn addition to logical expression, the filter can hold call based expressions. Below are the list of supported call expressions\n#### Exists\nExists call can be made to evaluate if the tag name exists in the list of tags on API. This call expression can be used as unary expression For e.g.\n``` tag.SOME_TAG.Exists() ```\n#### Any\nAny call can be made in a simple expression to evaluate if the tag with any name has specified value or not in the list of tags on the API. For e.g.\n``` tag.Any() == \"Tag with some value\" || tag.Any() != \"Tag with other value\" ```\n#### Contains\nContains call can be made in a simple expression to evaluate if the the specified tag contains specified argument as value. This call expression requires string argument that will be used to perform lookup in tag value For e.g.\n``` tag.Contains(\"somevalue\") ```\n#### MatchRegEx\nMatchRegEx call can be used for evaluating the specified tag value to match specified regular expression. This call expression requires a regular expression as the argument. For e.g.\n``` tag.MatchRegEx(\"(some){1}\") ```\n" }, "additionalTags" : { "type" : "array", "description" : "The list of tags to be added to the API service resource that the agent publishes to Amplify Central", "items" : { "type" : "string" } }, "ignoreTags" : { "type" : "array", "description" : "The list of tags to exclude from the API service resource that the agent publishes to Amplify Central", "items" : { "type" : "string" } }, "owningTeam" : { "type" : "string", "description" : "Name of the team that owns the catalog item created by agent. If not provided, the default team will be used." }, "owner" : { "type" : "object", "description" : "Owner of the resources that the agent discovers.", "properties" : { "type" : { "type" : "string", "description" : "The type of the owner. Defaults to team if not present.", "enum" : [ "team" ], "default" : "team" }, "id" : { "type" : "string", "description" : "Id of the owner of the resource.", "maxLength" : 36 } }, "required" : [ "id" ], "additionalProperties" : false } }, "additionalProperties" : false }, "logging" : { "type" : "object", "description" : "Logging config", "properties" : { "level" : { "type" : "string", "description" : "Defines the log level.", "enum" : [ "error", "warn", "info", "debug" ] } }, "additionalProperties" : false } }, "required" : [ "dataplaneType", "config" ], "additionalProperties" : false }, "management.v1alpha1.DiscoveryAgentStatus" : { "type" : "object", "properties" : { "version" : { "type" : "string", "x-amplify-index" : { }, "description" : "Version name for the agent revision.", "maxLength" : 255, "pattern" : "^(?!\\s).*(?