{"id":24649097,"url":"https://github.com/ow2-proactive/catalog-client","last_synced_at":"2025-05-13T11:15:12.645Z","repository":{"id":22975975,"uuid":"97839598","full_name":"ow2-proactive/catalog-client","owner":"ow2-proactive","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-25T14:50:42.000Z","size":573,"stargazers_count":0,"open_issues_count":1,"forks_count":11,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-13T11:15:02.157Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ow2-proactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-20T13:38:07.000Z","updated_at":"2025-03-27T11:26:24.000Z","dependencies_parsed_at":"2025-03-27T12:36:24.084Z","dependency_job_id":null,"html_url":"https://github.com/ow2-proactive/catalog-client","commit_stats":null,"previous_names":[],"tags_count":133,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow2-proactive%2Fcatalog-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow2-proactive%2Fcatalog-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow2-proactive%2Fcatalog-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow2-proactive%2Fcatalog-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ow2-proactive","download_url":"https://codeload.github.com/ow2-proactive/catalog-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253929377,"owners_count":21985804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-25T17:15:45.740Z","updated_at":"2025-05-13T11:15:12.630Z","avatar_url":"https://github.com/ow2-proactive.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi-java-client\n\nCatalogObjectEntity Catalog API\n\n- API version: 1.0\\\u0026quot;\n\n- Build date: 2025-03-27T12:13:03.112691600+01:00[Europe/Berlin]\n\nThe purpose of the catalog is to store ProActive objects.\n\nA catalog is subdivided into buckets.\n\n Each bucket manages zero, one or more\nversioned ProActive objects.\n\n\n*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*\n\n## Requirements\n\nBuilding the API client library requires:\n\n1. Java 1.8+\n2. Maven (3.8.3+)/Gradle (7.2+)\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn clean install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn clean deploy\n```\n\nRefer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.openapitools\u003c/groupId\u003e\n  \u003cartifactId\u003eopenapi-java-client\u003c/artifactId\u003e\n  \u003cversion\u003e1.0\"\u003c/version\u003e\n  \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\n  repositories {\n    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.\n    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.\n  }\n\n  dependencies {\n     implementation \"org.openapitools:openapi-java-client:1.0\"\"\n  }\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n```shell\nmvn clean package\n```\n\nThen manually install the following JARs:\n\n- `target/openapi-java-client-1.0\".jar`\n- `target/lib/*.jar`\n\n## Usage\n\nTo add a HTTP proxy for the API client, use `ClientConfig`:\n```java\n\nimport org.glassfish.jersey.apache.connector.ApacheConnectorProvider;\nimport org.glassfish.jersey.client.ClientConfig;\nimport org.glassfish.jersey.client.ClientProperties;\nimport org.ow2.proactive.catalog.client.*;\nimport org.ow2.proactive.catalog.client.api.BucketControllerApi;\n\n...\n\nApiClient defaultClient = Configuration.getDefaultApiClient();\nClientConfig clientConfig = defaultClient.getClientConfig();\nclientConfig.connectorProvider(new ApacheConnectorProvider());\nclientConfig.property(ClientProperties.PROXY_URI, \"http://proxy_url_here\");\nclientConfig.property(ClientProperties.PROXY_USERNAME, \"proxy_username\");\nclientConfig.property(ClientProperties.PROXY_PASSWORD, \"proxy_password\");\ndefaultClient.setClientConfig(clientConfig);\n\nBucketControllerApi apiInstance = new BucketControllerApi(defaultClient);\n\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\nimport org.ow2.proactive.catalog.client.*;\nimport org.ow2.proactive.catalog.client.auth.*;\nimport org.ow2.proactive.catalog.client.model.*;\nimport org.ow2.proactive.catalog.client.api.BucketControllerApi;\n\npublic class BucketControllerApiExample {\n\n    public static void main(String[] args) {\n        ApiClient defaultClient = Configuration.getDefaultApiClient();\n        defaultClient.setBasePath(\"https://trydev2.activeeon.com:8443/catalog\");\n        \n        BucketControllerApi apiInstance = new BucketControllerApi(defaultClient);\n        String sessionID = \"sessionID_example\"; // String | sessionID\n        String owner = \"owner_example\"; // String | The name of the user who owns the Bucket\n        String tenant = \"tenant_example\"; // String | The name of the tenant that has access to the Bucket\n        String kind = \"kind_example\"; // String | The kind(s) of objects that buckets must contain.\u003cbr /\u003eMultiple kinds can be specified using comma separators\n        String contentType = \"contentType_example\"; // String | The Content-Type of objects that buckets must contain\n        String objectTag = \"objectTag_example\"; // String | The tag of objects that buckets must contain\n        String associationStatus = \"ALL\"; // String | The buckets must contain objects which have the given job-planner association status.\u003cbr /\u003eCan be ALL, PLANNED, DEACTIVATED, FAILED or UNPLANNED.\u003cbr /\u003eALL will filter objects which have an association with any status.\u003cbr /\u003eUNPLANNED will filter objects without any association.\n        String objectName = \"objectName_example\"; // String | The name of objects that buckets must contain\n        String bucketName = \"bucketName_example\"; // String | The bucket name contains the value of this parameter (case insensitive)\n        String projectName = \"projectName_example\"; // String | Include only objects whose project name contains the given string.\n        String lastCommitBy = \"lastCommitBy_example\"; // String | Include only objects whose last commit belong to the given user.\n        String committedAtLeastOnceBy = \"committedAtLeastOnceBy_example\"; // String | Include only objects have been committed at least once by the given user.\n        Long lastCommitTimeGreater = 0L; // Long | Include only objects whose last commit time is greater than the given EPOCH time.\n        Long lastCommitTimeLessThan = 0L; // Long | Include only objects whose last commit time is less than the given EPOCH time.\n        String allBuckets = \"false\"; // String | If true, buckets without objects matching the filters will be returned with objectCount=0. Default is false\n        try {\n            List\u003cBucketMetadata\u003e result = apiInstance.callList(sessionID, owner, tenant, kind, contentType, objectTag, associationStatus, objectName, bucketName, projectName, lastCommitBy, committedAtLeastOnceBy, lastCommitTimeGreater, lastCommitTimeLessThan, allBuckets);\n            System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling BucketControllerApi#callList\");\n            System.err.println(\"Status code: \" + e.getCode());\n            System.err.println(\"Reason: \" + e.getResponseBody());\n            System.err.println(\"Response headers: \" + e.getResponseHeaders());\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://trydev2.activeeon.com:8443/catalog*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BucketControllerApi* | [**callList**](docs/BucketControllerApi.md#callList) | **GET** /buckets | Lists the buckets\n*BucketControllerApi* | [**cleanEmpty**](docs/BucketControllerApi.md#cleanEmpty) | **DELETE** /buckets | Delete the empty buckets\n*BucketControllerApi* | [**create**](docs/BucketControllerApi.md#create) | **POST** /buckets | Creates a new bucket\n*BucketControllerApi* | [**delete**](docs/BucketControllerApi.md#delete) | **DELETE** /buckets/{bucketName} | Delete an empty bucket\n*BucketControllerApi* | [**getMetadata**](docs/BucketControllerApi.md#getMetadata) | **GET** /buckets/{bucketName} | Gets a bucket\u0026#39;s metadata by ID\n*BucketControllerApi* | [**updateBucketOwner**](docs/BucketControllerApi.md#updateBucketOwner) | **PUT** /buckets/{bucketName} | Update bucket owner\n*BucketGrantControllerApi* | [**createBucketGrantForAGroup**](docs/BucketGrantControllerApi.md#createBucketGrantForAGroup) | **POST** /buckets/{bucketName}/grant/group | Create a new user group grant access for a bucket\n*BucketGrantControllerApi* | [**createBucketGrantForAUser**](docs/BucketGrantControllerApi.md#createBucketGrantForAUser) | **POST** /buckets/{bucketName}/grant/user | Create a new user grant access for a bucket\n*BucketGrantControllerApi* | [**deleteAllBucketGrantsAssignedToABucket**](docs/BucketGrantControllerApi.md#deleteAllBucketGrantsAssignedToABucket) | **DELETE** /buckets/{bucketName}/grant | Delete all grants assigned to a bucket\n*BucketGrantControllerApi* | [**deleteAllGrantsForABucketAndItsObjects**](docs/BucketGrantControllerApi.md#deleteAllGrantsForABucketAndItsObjects) | **DELETE** /buckets/{bucketName}/grant/all | Delete all grants associated with a bucket and all objects contained in this bucket\n*BucketGrantControllerApi* | [**deleteBucketGrantForAGroup**](docs/BucketGrantControllerApi.md#deleteBucketGrantForAGroup) | **DELETE** /buckets/{bucketName}/grant/group | Delete a group grant access for a bucket\n*BucketGrantControllerApi* | [**deleteBucketGrantForAUser**](docs/BucketGrantControllerApi.md#deleteBucketGrantForAUser) | **DELETE** /buckets/{bucketName}/grant/user | Delete a user grant access for a bucket\n*BucketGrantControllerApi* | [**getAllGrantsForABucket**](docs/BucketGrantControllerApi.md#getAllGrantsForABucket) | **GET** /buckets/{bucketName}/grant | Get all grants associated with a bucket\n*BucketGrantControllerApi* | [**getAllGrantsForABucketAndItsObjects**](docs/BucketGrantControllerApi.md#getAllGrantsForABucketAndItsObjects) | **GET** /buckets/{bucketName}/grant/all | Get all grants associated with a bucket and all objects contained in this bucket\n*BucketGrantControllerApi* | [**updateBucketGrantForAGroup**](docs/BucketGrantControllerApi.md#updateBucketGrantForAGroup) | **PUT** /buckets/{bucketName}/grant/group | Update the access type of an existing group bucket grant\n*BucketGrantControllerApi* | [**updateBucketGrantForAUser**](docs/BucketGrantControllerApi.md#updateBucketGrantForAUser) | **PUT** /buckets/{bucketName}/grant/user | Update the access type of an existing user bucket grant\n*CatalogObjectCallGraphControllerApi* | [**getCallGraph**](docs/CatalogObjectCallGraphControllerApi.md#getCallGraph) | **GET** /buckets/call-graph | Get a ZIP file containing a call graph report for each catalog objects matching the provided filters\n*CatalogObjectCallGraphControllerApi* | [**getCallGraphForSelectedObjects**](docs/CatalogObjectCallGraphControllerApi.md#getCallGraphForSelectedObjects) | **GET** /buckets/call-graph/selected/{bucketName} | Get the call graph of selected catalog objects in a bucket\n*CatalogObjectControllerApi* | [**create1**](docs/CatalogObjectControllerApi.md#create1) | **POST** /buckets/{bucketName}/resources | Creates a new catalog object\n*CatalogObjectControllerApi* | [**delete1**](docs/CatalogObjectControllerApi.md#delete1) | **DELETE** /buckets/{bucketName}/resources/{name} | Delete a catalog object\n*CatalogObjectControllerApi* | [**exportCatalogObjects**](docs/CatalogObjectControllerApi.md#exportCatalogObjects) | **POST** /buckets/{bucketName}/resources/export | Export catalog objects as a plain zip archive or a ProActive Catalog Package\n*CatalogObjectControllerApi* | [**get**](docs/CatalogObjectControllerApi.md#get) | **GET** /buckets/{bucketName}/resources/{name} | Gets a catalog object\u0026#39;s metadata by IDs\n*CatalogObjectControllerApi* | [**getDependencies**](docs/CatalogObjectControllerApi.md#getDependencies) | **GET** /buckets/{bucketName}/resources/{name}/dependencies | Gets dependencies (dependsOn and calledBy) of a catalog object\n*CatalogObjectControllerApi* | [**getRaw1**](docs/CatalogObjectControllerApi.md#getRaw1) | **GET** /buckets/{bucketName}/resources/{name}/raw | Gets the raw content of the last revision of a catalog object\n*CatalogObjectControllerApi* | [**importCatalogObjects**](docs/CatalogObjectControllerApi.md#importCatalogObjects) | **POST** /buckets/{bucketName}/resources/import | Import an archive, either a plain zip or a ProActive Catalog package\n*CatalogObjectControllerApi* | [**list1**](docs/CatalogObjectControllerApi.md#list1) | **GET** /buckets/{bucketName}/resources | Lists catalog objects metadata\n*CatalogObjectControllerApi* | [**listCatalogObjectNameReference**](docs/CatalogObjectControllerApi.md#listCatalogObjectNameReference) | **GET** /buckets/references | Lists catalog object name references by kind and Content-Type\n*CatalogObjectControllerApi* | [**listContentTypes**](docs/CatalogObjectControllerApi.md#listContentTypes) | **GET** /buckets/content-types | Lists all Content-Types for all objects\n*CatalogObjectControllerApi* | [**listKinds**](docs/CatalogObjectControllerApi.md#listKinds) | **GET** /buckets/kinds | Lists all kinds for all objects\n*CatalogObjectControllerApi* | [**listObjectTags**](docs/CatalogObjectControllerApi.md#listObjectTags) | **GET** /buckets/tags | Lists all tags values for all objects stored in the catalog\n*CatalogObjectControllerApi* | [**updateObjectMetadata**](docs/CatalogObjectControllerApi.md#updateObjectMetadata) | **PUT** /buckets/{bucketName}/resources/{name} | Update a catalog object metadata, like kind, Content-Type, project name and tags\n*CatalogObjectControllerApi* | [**updateObjectMetadataMulti**](docs/CatalogObjectControllerApi.md#updateObjectMetadataMulti) | **PUT** /buckets/resources/metadata | Updates metadata, like kind, Content-Type, project name and tags for multiple objects\n*CatalogObjectGrantControllerApi* | [**createCatalogObjectGrantForAGroup**](docs/CatalogObjectGrantControllerApi.md#createCatalogObjectGrantForAGroup) | **POST** /buckets/{bucketName}/resources/{catalogObjectName}/grant/group | Create a new group grant for a catalog object\n*CatalogObjectGrantControllerApi* | [**createCatalogObjectGrantForAUser**](docs/CatalogObjectGrantControllerApi.md#createCatalogObjectGrantForAUser) | **POST** /buckets/{bucketName}/resources/{catalogObjectName}/grant/user | Create a new user grant for a catalog object\n*CatalogObjectGrantControllerApi* | [**deleteAllCatalogObjectGrants**](docs/CatalogObjectGrantControllerApi.md#deleteAllCatalogObjectGrants) | **DELETE** /buckets/{bucketName}/resources/{catalogObjectName}/grant | Delete all grant associated with a catalog object\n*CatalogObjectGrantControllerApi* | [**deleteCatalogObjectGrantForAGroup**](docs/CatalogObjectGrantControllerApi.md#deleteCatalogObjectGrantForAGroup) | **DELETE** /buckets/{bucketName}/resources/{catalogObjectName}/grant/group | Delete a user group grant access for a catalog object\n*CatalogObjectGrantControllerApi* | [**deleteCatalogObjectGrantForAUser**](docs/CatalogObjectGrantControllerApi.md#deleteCatalogObjectGrantForAUser) | **DELETE** /buckets/{bucketName}/resources/{catalogObjectName}/grant/user | Delete a user grant access for a catalog object\n*CatalogObjectGrantControllerApi* | [**getAllCreatedCatalogObjectGrantsByAdmins**](docs/CatalogObjectGrantControllerApi.md#getAllCreatedCatalogObjectGrantsByAdmins) | **GET** /buckets/{bucketName}/resources/{catalogObjectName}/grant | Get all grants associated with a catalog object\n*CatalogObjectGrantControllerApi* | [**updateCatalogObjectGrantForAGroup**](docs/CatalogObjectGrantControllerApi.md#updateCatalogObjectGrantForAGroup) | **PUT** /buckets/{bucketName}/resources/{catalogObjectName}/grant/group | Update a user group grant access for a catalog object\n*CatalogObjectGrantControllerApi* | [**updateCatalogObjectGrantForAUser**](docs/CatalogObjectGrantControllerApi.md#updateCatalogObjectGrantForAUser) | **PUT** /buckets/{bucketName}/resources/{catalogObjectName}/grant/user | Update a user grant access for a catalog object\n*CatalogObjectReportControllerApi* | [**getReport**](docs/CatalogObjectReportControllerApi.md#getReport) | **GET** /buckets/report | Get a ZIP file containing the PDF reports for each catalog objects matching the provided filters\n*CatalogObjectReportControllerApi* | [**getReportForSelectedObjects**](docs/CatalogObjectReportControllerApi.md#getReportForSelectedObjects) | **POST** /buckets/report/selected/{bucketName} | Get a PDF report file for the selected catalog items\n*CatalogObjectRevisionControllerApi* | [**create2**](docs/CatalogObjectRevisionControllerApi.md#create2) | **POST** /buckets/{bucketName}/resources/{name}/revisions | Creates a new catalog object revision\n*CatalogObjectRevisionControllerApi* | [**get1**](docs/CatalogObjectRevisionControllerApi.md#get1) | **GET** /buckets/{bucketName}/resources/{name}/revisions/{commitTimeRaw} | Gets a specific revision\n*CatalogObjectRevisionControllerApi* | [**getRaw**](docs/CatalogObjectRevisionControllerApi.md#getRaw) | **GET** /buckets/{bucketName}/resources/{name}/revisions/{commitTimeRaw}/raw | Gets the raw content of a specific revision\n*CatalogObjectRevisionControllerApi* | [**list2**](docs/CatalogObjectRevisionControllerApi.md#list2) | **GET** /buckets/{bucketName}/resources/{name}/revisions | Lists a catalog object revisions\n*CatalogObjectRevisionControllerApi* | [**restore**](docs/CatalogObjectRevisionControllerApi.md#restore) | **PUT** /buckets/{bucketName}/resources/{name}/revisions/{commitTimeRaw} | Restore a catalog object revision\n*GraphqlControllerApi* | [**executeOperation**](docs/GraphqlControllerApi.md#executeOperation) | **POST** /graphql | \n\n\n## Documentation for Models\n\n - [AllBucketGrants](docs/AllBucketGrants.md)\n - [BucketGrantMetadata](docs/BucketGrantMetadata.md)\n - [BucketMetadata](docs/BucketMetadata.md)\n - [CatalogObjectDependencies](docs/CatalogObjectDependencies.md)\n - [CatalogObjectGrantMetadata](docs/CatalogObjectGrantMetadata.md)\n - [CatalogObjectID](docs/CatalogObjectID.md)\n - [CatalogObjectMetadata](docs/CatalogObjectMetadata.md)\n - [CatalogObjectMetadataList](docs/CatalogObjectMetadataList.md)\n - [CatalogObjectNameReference](docs/CatalogObjectNameReference.md)\n - [DependsOnCatalogObject](docs/DependsOnCatalogObject.md)\n - [JobVariable](docs/JobVariable.md)\n - [Link](docs/Link.md)\n - [Metadata](docs/Metadata.md)\n - [ModificationHistoryData](docs/ModificationHistoryData.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation for Authorization\n\nEndpoints do not require authorization.\n\n\n## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.\n\n## Author\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fow2-proactive%2Fcatalog-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fow2-proactive%2Fcatalog-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fow2-proactive%2Fcatalog-client/lists"}