@RestController
@RequestMapping(value="/rest",
produces={"application/xml","application/json"})
public class BusinessObjectDataRestController
extends HerdBaseController
| Constructor and Description |
|---|
BusinessObjectDataRestController() |
| Modifier and Type | Method and Description |
|---|---|
BusinessObjectDataAvailability |
checkBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest)
Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.
|
BusinessObjectDataAvailabilityCollectionResponse |
checkBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest)
Performs an availability check for a collection of business object data.
|
BusinessObjectData |
createBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest)
Creates (i.e.
|
BusinessObjectData |
deleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
Boolean deleteFiles)
Deletes an existing business object data without subpartition values with namespace.
|
BusinessObjectData |
deleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
Deletes an existing business object data with 1 subpartition value with namespace.
|
BusinessObjectData |
deleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
Deletes an existing business object data with 2 subpartition values with namespace.
|
BusinessObjectData |
deleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
Deletes an existing business object data with 3 subpartition values with namespace
|
BusinessObjectData |
deleteBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
String subPartition4Value,
Integer businessObjectDataVersion,
Boolean deleteFiles)
Deletes an existing business object data with 4 subpartition values with namespace.
|
BusinessObjectData |
destroyBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String subPartitionValues)
Initiates destruction process for an existing business object data.
|
BusinessObjectDataDdl |
generateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest)
Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the
specified storage.
|
BusinessObjectDataDdlCollectionResponse |
generateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest)
Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified
storage.
|
BusinessObjectDataKeys |
getAllBusinessObjectDataByBusinessObjectDefinition(String namespace,
String businessObjectDefinitionName)
Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object definition.
|
BusinessObjectDataKeys |
getAllBusinessObjectDataByBusinessObjectFormat(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion)
Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object format.
|
BusinessObjectData |
getBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
String businessObjectFormatPartitionKey,
String partitionValue,
String subPartitionValues,
Integer businessObjectFormatVersion,
Integer businessObjectDataVersion,
String businessObjectDataStatus,
Boolean includeBusinessObjectDataStatusHistory,
Boolean includeStorageUnitStatusHistory)
Retrieves existing business object data entry information.
|
BusinessObjectDataDownloadCredential |
getBusinessObjectDataDownloadCredential(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String storageName,
String subPartitionValues)
Gets the AWS credential to download to the specified business object data and storage.
|
BusinessObjectDataUploadCredential |
getBusinessObjectDataUploadCredential(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
Boolean createNewVersion,
String storageName,
String subPartitionValues)
Gets the AWS credential to upload to the specified business object data and storage.
|
BusinessObjectDataVersions |
getBusinessObjectDataVersions(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
String partitionValue,
String subPartitionValues,
Integer businessObjectFormatVersion,
Integer businessObjectDataVersion)
Retrieves a list of existing business object data versions.
|
S3KeyPrefixInformation |
getS3KeyPrefix(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionKey,
String partitionValue,
String subPartitionValues,
Integer businessObjectDataVersion,
String storageName,
Boolean createNewVersion,
javax.servlet.ServletRequest servletRequest)
Gets the S3 key prefix for writing or accessing business object data.
|
BusinessObjectDataInvalidateUnregisteredResponse |
invalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)
Registers data as INVALID for objects which exist in S3 but are not registered in herd.
|
BusinessObjectData |
restoreBusinessObjectData(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String subPartitionValues,
Integer expirationInDays,
String archiveRetrievalOption)
Initiates a restore request for a currently archived business object data.
|
BusinessObjectData |
retryStoragePolicyTransition(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String subPartitionValues,
BusinessObjectDataRetryStoragePolicyTransitionRequest request)
Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of
a valid archiving operation.
|
BusinessObjectDataSearchResult |
searchBusinessObjectData(Integer pageNum,
Integer pageSize,
BusinessObjectDataSearchRequest businessObjectDataSearchRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
Searches business object data based on namespace, definition name, format usage, file type, and format version.
|
BusinessObjectData |
updateBusinessObjectDataAttributes(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
BusinessObjectDataAttributesUpdateRequest request)
Updates attributes for the business object data without subpartition values.
|
BusinessObjectData |
updateBusinessObjectDataAttributes(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
Integer businessObjectDataVersion,
BusinessObjectDataAttributesUpdateRequest request)
Updates attributes for the business object data with 1 subpartition value.
|
BusinessObjectData |
updateBusinessObjectDataAttributes(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
Integer businessObjectDataVersion,
BusinessObjectDataAttributesUpdateRequest request)
Updates attributes for the business object data with 2 subpartition values.
|
BusinessObjectData |
updateBusinessObjectDataAttributes(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
Integer businessObjectDataVersion,
BusinessObjectDataAttributesUpdateRequest request)
Updates attributes for the business object data with 3 subpartition values.
|
BusinessObjectData |
updateBusinessObjectDataAttributes(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
String subPartition1Value,
String subPartition2Value,
String subPartition3Value,
String subPartition4Value,
Integer businessObjectDataVersion,
BusinessObjectDataAttributesUpdateRequest request)
Updates attributes for the business object data with 4 subpartition values.
|
BusinessObjectData |
updateBusinessObjectDataRetentionInformation(String namespace,
String businessObjectDefinitionName,
String businessObjectFormatUsage,
String businessObjectFormatFileType,
Integer businessObjectFormatVersion,
String partitionValue,
Integer businessObjectDataVersion,
String subPartitionValues,
BusinessObjectDataRetentionInformationUpdateRequest request)
Updates retention information for an existing business object data.
|
addPagingHttpHeaders, validateNoDuplicateQueryStringParams@RequestMapping(value="/businessObjectData/availability",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_AVAILABILITY_POST")
public BusinessObjectDataAvailability checkBusinessObjectDataAvailability(@RequestBody
BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest)
Requires READ permission on namespace
businessObjectDataAvailabilityRequest - the business object data availability request@RequestMapping(value="/businessObjectData/availabilityCollection",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_AVAILABILITY_COLLECTION_POST")
public BusinessObjectDataAvailabilityCollectionResponse checkBusinessObjectDataAvailabilityCollection(@RequestBody
BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest)
Requires READ permission on ALL namespaces
businessObjectDataAvailabilityCollectionRequest - the business object data availability collection request@RequestMapping(value="/businessObjectData",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_POST")
public BusinessObjectData createBusinessObjectData(@RequestBody
BusinessObjectDataCreateRequest businessObjectDataCreateRequest)
Requires WRITE permission on namespace
businessObjectDataCreateRequest - the information needed to create the business object data@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=DELETE)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DELETE")
public BusinessObjectData deleteBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="deleteFiles")
Boolean deleteFiles)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuebusinessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deleted@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=DELETE)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DELETE")
public BusinessObjectData deleteBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="deleteFiles")
Boolean deleteFiles)
Requires WRITE permission on namespace
namespace - the namespace.businessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deleted@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=DELETE)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DELETE")
public BusinessObjectData deleteBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="deleteFiles")
Boolean deleteFiles)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deleted@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=DELETE)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DELETE")
public BusinessObjectData deleteBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="subPartition3Value")
String subPartition3Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="deleteFiles")
Boolean deleteFiles)
Requires WRITE permission on namespace
namespace - the namespace.businessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2subPartition3Value - sub-partition value 3businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deleted@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=DELETE)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DELETE")
public BusinessObjectData deleteBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="subPartition3Value")
String subPartition3Value,
@PathVariable(value="subPartition4Value")
String subPartition4Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="deleteFiles")
Boolean deleteFiles)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuesubPartition1Value - sub-partition value 1subPartition2Value - sub-partition value 2subPartition3Value - sub-partition value 3subPartition4Value - sub-partition value 4businessObjectDataVersion - the business object data versiondeleteFiles - whether files should be deleted@RequestMapping(value="/businessObjectData/destroy/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=POST)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DESTROY_POST")
public BusinessObjectData destroyBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues)
Requires WRITE permission on namespace
namespace - the namespace of the business object definitionbusinessObjectDefinitionName - the name of the business object definitionbusinessObjectFormatUsage - the usage of the business object formatbusinessObjectFormatFileType - the file type of the business object formatbusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition valuesubPartitionValues - the list of sub-partition values delimited by "|" (delimiter can be escaped by "\")businessObjectDataVersion - the version of the business object data@RequestMapping(value="/businessObjectData/generateDdl",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_GENERATE_DDL_POST")
public BusinessObjectDataDdl generateBusinessObjectDataDdl(@RequestBody
BusinessObjectDataDdlRequest businessObjectDataDdlRequest)
Requires READ permission on namespace
businessObjectDataDdlRequest - the business object data DDL request@RequestMapping(value="/businessObjectData/generateDdlCollection",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_GENERATE_DDL_COLLECTION_POST")
public BusinessObjectDataDdlCollectionResponse generateBusinessObjectDataDdlCollection(@RequestBody
BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest)
Requires READ permission on ALL namespaces
businessObjectDataDdlCollectionRequest - the business object data DDL collection request@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_BY_BUSINESS_OBJECT_DEFINITION_GET")
public BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectDefinition(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName)
Results are sorted alphabetically by primary and sub-partition values descending.
The limit on how many records this endpoint returns is set by "business.object.data.search.max.results.per.page" configuration value.
Requires READ permission on namespace.
namespace - the namespacebusinessObjectDefinitionName - the business object definition name@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_BY_BUSINESS_OBJECT_FORMAT_GET")
public BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectFormat(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion)
Results are sorted alphabetically by primary and sub-partition values descending.
The limit on how many records this endpoint returns is set by "business.object.data.search.max.results.per.page" configuration value.
Requires READ permission on namespace.
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format version@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_GET")
public BusinessObjectData getBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@RequestParam(value="partitionKey",required=false)
String businessObjectFormatPartitionKey,
@RequestParam(value="partitionValue")
String partitionValue,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestParam(value="businessObjectFormatVersion",required=false)
Integer businessObjectFormatVersion,
@RequestParam(value="businessObjectDataVersion",required=false)
Integer businessObjectDataVersion,
@RequestParam(value="businessObjectDataStatus",required=false)
String businessObjectDataStatus,
@RequestParam(value="includeBusinessObjectDataStatusHistory",required=false)
Boolean includeBusinessObjectDataStatusHistory,
@RequestParam(value="includeStorageUnitStatusHistory",required=false)
Boolean includeStorageUnitStatusHistory)
Requires READ permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatPartitionKey - the partition key of the business object format. When specified, the partition key is validated against the
partition key associated with the relative business object formatpartitionValue - the partition value of the business object datasubPartitionValues - the list of sub-partition values delimited by "|" (delimiter can be escaped by "\")businessObjectFormatVersion - the version of the business object format. When the business object format version is not specified, the business
object data with the latest business format version available for the specified partition values is returnedbusinessObjectDataVersion - the version of the business object data. When business object data version is not specified, the latest version of
business object data of the specified business object data status is returnedbusinessObjectDataStatus - the status of the business object data. When business object data version is specified, this parameter is ignored.
Default value is "VALID"includeBusinessObjectDataStatusHistory - specifies to include business object data status history in the responseincludeStorageUnitStatusHistory - specifies to include storage unit status history for each storage unit in the response@RequestMapping(value="/businessObjectData/download/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_DOWNLOAD_CREDENTIAL_GET")
public BusinessObjectDataDownloadCredential getBusinessObjectDataDownloadCredential(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="storageName",required=true)
String storageName,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues)
Requires READ permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuebusinessObjectDataVersion - the business object data versionstorageName - the storage namesubPartitionValues - the list of sub-partition values@RequestMapping(value="/businessObjectData/upload/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_UPLOAD_CREDENTIAL_GET")
public BusinessObjectDataUploadCredential getBusinessObjectDataUploadCredential(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@RequestParam(value="businessObjectDataVersion",required=false)
Integer businessObjectDataVersion,
@RequestParam(value="createNewVersion",required=false)
Boolean createNewVersion,
@RequestParam(value="storageName",required=true)
String storageName,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition valuebusinessObjectDataVersion - the business object data versioncreateNewVersion - flag to create new versionstorageName - the storage namesubPartitionValues - the list of sub-partition values@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/versions",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_VERSIONS_GET")
public BusinessObjectDataVersions getBusinessObjectDataVersions(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@RequestParam(value="partitionValue")
String partitionValue,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestParam(value="businessObjectFormatVersion",required=false)
Integer businessObjectFormatVersion,
@RequestParam(value="businessObjectDataVersion",required=false)
Integer businessObjectDataVersion)
Requires READ permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typepartitionValue - the partition valuesubPartitionValues - the list of sub-partition valuesbusinessObjectFormatVersion - the business object format versionbusinessObjectDataVersion - the business object data version@RequestMapping(value="/businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/s3KeyPrefix",
method=GET)
@Secured(value="FN_BUSINESS_OBJECT_DATA_S3_KEY_PREFIX_GET")
public S3KeyPrefixInformation getS3KeyPrefix(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@RequestParam(value="partitionKey",required=false)
String partitionKey,
@RequestParam(value="partitionValue")
String partitionValue,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestParam(value="businessObjectDataVersion",required=false)
Integer businessObjectDataVersion,
@RequestParam(value="storageName",required=false)
String storageName,
@RequestParam(value="createNewVersion",required=false,defaultValue="false")
Boolean createNewVersion,
javax.servlet.ServletRequest servletRequest)
Gets the S3 key prefix for writing or accessing business object data.
This endpoint requires a namespace.
Requires READ permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionKey - the partition keypartitionValue - the partition valuesubPartitionValues - the list of sub-partition valuesbusinessObjectDataVersion - the business object data versionstorageName - the storage namecreateNewVersion - Whether a new business object data can be createdservletRequest - the servlet request@RequestMapping(value="/businessObjectData/unregistered/invalidation",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_UNREGISTERED_INVALIDATE")
public BusinessObjectDataInvalidateUnregisteredResponse invalidateUnregisteredBusinessObjectData(@RequestBody
BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)
Requires WRITE permission on namespace
businessObjectDataInvalidateUnregisteredRequest - the business object data invalidate un-register request@RequestMapping(value="/businessObjectData/restore/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_RESTORE_POST")
public BusinessObjectData restoreBusinessObjectData(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestParam(value="expirationInDays",required=false)
Integer expirationInDays,
@RequestParam(value="archiveRetrievalOption",required=false)
String archiveRetrievalOption)
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition value of the business object databusinessObjectDataVersion - the version of the business object datasubPartitionValues - the list of sub-partition values delimited by "|" (delimiter can be escaped by "\")expirationInDays - the time, in days, between when the business object data is restored to the S3 bucket and when it expiresarchiveRetrievalOption - the archive retrieval option when restoring an archived object. Currently three options are supported: Expedited, Standard,
and Bulk@RequestMapping(value="/businessObjectData/retryStoragePolicyTransition/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_RETRY_STORAGE_POLICY_TRANSITION_POST")
public BusinessObjectData retryStoragePolicyTransition(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestBody
BusinessObjectDataRetryStoragePolicyTransitionRequest request)
namespace - the namespace of the business object definitionbusinessObjectDefinitionName - the name of the business object definitionbusinessObjectFormatUsage - the usage of the business object formatbusinessObjectFormatFileType - the file type of the business object formatbusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition value of the business object databusinessObjectDataVersion - the version of the business object datasubPartitionValues - the optional list of sub-partition values delimited by "|" (delimiter can be escaped by "\")request - the information needed to retry a storage policy transition@RequestMapping(value="/businessObjectData/search",
method=POST,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_SEARCH_POST")
public BusinessObjectDataSearchResult searchBusinessObjectData(@RequestParam(value="pageNum",required=false)
Integer pageNum,
@RequestParam(value="pageSize",required=false)
Integer pageSize,
@RequestBody
BusinessObjectDataSearchRequest businessObjectDataSearchRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
Namespace and definition name are required.
Requires READ permission on namespace
The response contains the following HTTP headers:
pageNum - the page number. If this parameter is specified, results contain the appropriate page that is specified. Page numbers are one-based - that
is the first page number is one. Default value is 1pageSize - the page size. If pageSize parameter is specified, results contain that number of business object data (unless it is the end of the
result set). Default value is 1000businessObjectDataSearchRequest - the business object data search requesthttpServletResponse - the HTTP servlet response@RequestMapping(value="/businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_ATTRIBUTES_ALL_PUT")
public BusinessObjectData updateBusinessObjectDataAttributes(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestBody
BusinessObjectDataAttributesUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the partition value of the business object databusinessObjectDataVersion - the business object data versionrequest - the information needed to update the business object data attributes@RequestMapping(value="/businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_ATTRIBUTES_ALL_PUT")
public BusinessObjectData updateBusinessObjectDataAttributes(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestBody
BusinessObjectDataAttributesUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the primary partition value of the business object datasubPartition1Value - the 1st subpartition value of the business object databusinessObjectDataVersion - the business object data versionrequest - the information needed to update the business object data attributes@RequestMapping(value="/businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_ATTRIBUTES_ALL_PUT")
public BusinessObjectData updateBusinessObjectDataAttributes(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestBody
BusinessObjectDataAttributesUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the primary partition value of the business object datasubPartition1Value - the 1st subpartition value of the business object datasubPartition2Value - the 2nd subpartition value of the business object databusinessObjectDataVersion - the business object data versionrequest - the information needed to update the business object data attributes@RequestMapping(value="/businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_ATTRIBUTES_ALL_PUT")
public BusinessObjectData updateBusinessObjectDataAttributes(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="subPartition3Value")
String subPartition3Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestBody
BusinessObjectDataAttributesUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the primary partition value of the business object datasubPartition1Value - the 1st subpartition value of the business object datasubPartition2Value - the 2nd subpartition value of the business object datasubPartition3Value - the 3rd subpartition value of the business object databusinessObjectDataVersion - the business object data versionrequest - the information needed to update the business object data attributes@RequestMapping(value="/businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_ATTRIBUTES_ALL_PUT")
public BusinessObjectData updateBusinessObjectDataAttributes(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="subPartition1Value")
String subPartition1Value,
@PathVariable(value="subPartition2Value")
String subPartition2Value,
@PathVariable(value="subPartition3Value")
String subPartition3Value,
@PathVariable(value="subPartition4Value")
String subPartition4Value,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestBody
BusinessObjectDataAttributesUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespacebusinessObjectDefinitionName - the business object definition namebusinessObjectFormatUsage - the business object format usagebusinessObjectFormatFileType - the business object format file typebusinessObjectFormatVersion - the business object format versionpartitionValue - the primary partition value of the business object datasubPartition1Value - the 1st subpartition value of the business object datasubPartition2Value - the 2nd subpartition value of the business object datasubPartition3Value - the 3rd subpartition value of the business object datasubPartition4Value - the 4th subpartition value of the business object databusinessObjectDataVersion - the business object data versionrequest - the information needed to update the business object data attributes@RequestMapping(value="/businessObjectDataRetentionInformation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
method=PUT,
consumes={"application/xml","application/json"})
@Secured(value="FN_BUSINESS_OBJECT_DATA_RETENTION_INFORMATION_PUT")
public BusinessObjectData updateBusinessObjectDataRetentionInformation(@PathVariable(value="namespace")
String namespace,
@PathVariable(value="businessObjectDefinitionName")
String businessObjectDefinitionName,
@PathVariable(value="businessObjectFormatUsage")
String businessObjectFormatUsage,
@PathVariable(value="businessObjectFormatFileType")
String businessObjectFormatFileType,
@PathVariable(value="businessObjectFormatVersion")
Integer businessObjectFormatVersion,
@PathVariable(value="partitionValue")
String partitionValue,
@PathVariable(value="businessObjectDataVersion")
Integer businessObjectDataVersion,
@RequestParam(value="subPartitionValues",required=false)
String subPartitionValues,
@RequestBody
BusinessObjectDataRetentionInformationUpdateRequest request)
Requires WRITE permission on namespace
namespace - the namespace of the business object definitionbusinessObjectDefinitionName - the name of the business object definitionbusinessObjectFormatUsage - the usage of the business object formatbusinessObjectFormatFileType - the file type of the business object formatbusinessObjectFormatVersion - the version of the business object formatpartitionValue - the primary partition valuesubPartitionValues - the list of sub-partition values delimited by "|" (delimiter can be escaped by "\")businessObjectDataVersion - the version of the business object datarequest - the business object data retention information update requestCopyright © 2019. All rights reserved.