@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class DataObjectsApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
DataObjectsApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry based on a given
ApiClient . |
DataObjectsApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry.
|
Modifier and Type | Method and Description |
---|---|
DataObjectObject |
addDataObject(String id,
DataObjectObject body)
Create a data object
|
OpenApiResponse |
deleteDataObject(String id,
String objectId)
Delete a data object of a project
|
DataObjectObject |
readDataObject(String id,
String objectId)
Retrieves a data object of a project
|
List<DataObjectObject> |
readDataObjects(String id)
Retrieve all the data objects of a project
|
List<DataObjectObject> |
readDataObjects(String id,
List<String> name,
Integer $skip,
Integer $top)
Retrieve all the data objects of a project
|
DataObjectObject |
readRevisionedDataObjects(String id,
String revision)
Retrieve all the data objects of the highest semantic version of a project for a given revision.
|
DataObjectObject |
readRevisionedDataObjects(String id,
String revision,
List<String> name)
Retrieve all the data objects of the highest semantic version of a project for a given revision.
|
DataObjectObject |
readVersionedDataObjects(String id,
String version)
Retrieve all the data objects of a project given version id
|
DataObjectObject |
readVersionedDataObjects(String id,
String version,
List<String> name)
Retrieve all the data objects of a project given version id
|
DataObjectObject |
updateDataObject(String id,
String objectId)
Update a data object of a project
|
DataObjectObject |
updateDataObject(String id,
String objectId,
DataObjectObject body)
Update a data object of a project
|
public DataObjectsApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public DataObjectObject addDataObject(@Nonnull String id, @Nonnull DataObjectObject body) throws OpenApiRequestException
Create a data object
Creates a data object for the project with the specified project ID.
201 - Created. The data object has been added successfully to the given project.
400 - Bad Request. ID of the project in the URL path and in JSON payload does not match.
401 - Unauthorized. User does not have required authorization to execute this request.
409 - Conflict. A data object with name specified in JSON payload already exists in the given project.
id
- ID of the project to which the data object should be added. The ID is 32 characters long.body
- JSON payload of the data object.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse deleteDataObject(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Delete a data object of a project
Deletes the data object with the specified data object ID of the project with the specified project ID.
204 - Data object deleted successfully from the given project.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to delete does not exist.
id
- ID of the project from which the data object should be deleted. The ID is 32 characters long.objectId
- Id of the data object.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject readDataObject(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Retrieves a data object of a project
Retrieves the data object with specified data object ID of the project with the specified project ID.
200 - Request for reading the data object belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.objectId
- ID of the data object. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<DataObjectObject> readDataObjects(@Nonnull String id, @Nullable List<String> name, @Nullable Integer $skip, @Nullable Integer $top) throws OpenApiRequestException
Retrieve all the data objects of a project
Retrieves all the data objects of the project with the specified project ID.
200 - Request for reading the data objects belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.name
- (Optional The name of the data objects. Retrieves the data object with the specified name. You can
provide multiple names to retrieve multiple data objects.$skip
- (Optional, default to 0) The number of data objects you want to skip from the beginning while fetching
them. If $skip is not specified, no data objects are skipped. The records are implicitly sorted by the
data object name in ascending order. You can use this parameter only once. For example: To
fetch the data objects starting from 101 until 150, set $skip=100 and $top=50. Also, refer
to the $top parameter.$top
- (Optional, default to 100) The number of data objects you want to fetch from the beginning. If not
specified, 100 data objects are returned. The records are implicitly sorted by the data object name in
ascending order. You can use this parameter only once. For example: To fetch the data objects
starting from 101 until 150, set $skip=100 and $top=50. Also, refer to the $skip parameter.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<DataObjectObject> readDataObjects(@Nonnull String id) throws OpenApiRequestException
Retrieve all the data objects of a project
Retrieves all the data objects of the project with the specified project ID.
200 - Request for reading the data objects belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject readRevisionedDataObjects(@Nonnull String id, @Nonnull String revision, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the data objects of the highest semantic version of a project for a given revision.
Retrieves all the data objects of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned data objects of a given project is completed.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.revision
- (Required) Revision of the project.name
- (Optional The name of the data objects. Retrieves the data object with the specified name. You can
provide multiple names to retrieve multiple data objects.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject readRevisionedDataObjects(@Nonnull String id, @Nonnull String revision) throws OpenApiRequestException
Retrieve all the data objects of the highest semantic version of a project for a given revision.
Retrieves all the data objects of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned data objects of a given project is completed.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.revision
- Revision of the project.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject readVersionedDataObjects(@Nonnull String id, @Nonnull String version, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the data objects of a project given version id
Retrieves all the data objects given version id with the specified project ID.
200 - Request for reading versioned data objects belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.version
- (Required) Version ID of the project. The ID is 18 digits long.name
- (Optional The name of the data objects. Retrieves the data object with the specified name. You can
provide multiple names to retrieve multiple data objects.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject readVersionedDataObjects(@Nonnull String id, @Nonnull String version) throws OpenApiRequestException
Retrieve all the data objects of a project given version id
Retrieves all the data objects given version id with the specified project ID.
200 - Request for reading versioned data objects belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.version
- Version ID of the project. The ID is 18 digits long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject updateDataObject(@Nonnull String id, @Nonnull String objectId, @Nullable DataObjectObject body) throws OpenApiRequestException
Update a data object of a project
Updates the data object with the specified data object ID of the project with the specified project ID.
200 - Request to update the data object belonging to a given project is completed successfully.
400 - Bad Request. ID of the project or of the data object provided in the URL path and in JSON payload do not match.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to update does not exist.
409 - Conflict. A data object with name specified in JSON payload already exists in the given project.
id
- (Required) ID of the project. The ID is 32 characters long.objectId
- (Required) ID of the data object. The ID is 32 characters long.body
- (Optional) JSON payload of the data object.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DataObjectObject updateDataObject(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Update a data object of a project
Updates the data object with the specified data object ID of the project with the specified project ID.
200 - Request to update the data object belonging to a given project is completed successfully.
400 - Bad Request. ID of the project or of the data object provided in the URL path and in JSON payload do not match.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to update does not exist.
409 - Conflict. A data object with name specified in JSON payload already exists in the given project.
id
- ID of the project. The ID is 32 characters long.objectId
- ID of the data object. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.