Skip to content

/AWS1/IF_FND=>UPDATECHANGESET()

About UpdateChangeset

Updates a FinSpace Changeset.

Method Signature

METHODS /AWS1/IF_FND~UPDATECHANGESET
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/FNDCLIENTTOKEN OPTIONAL
    !IV_DATASETID TYPE /AWS1/FNDDATASETID OPTIONAL
    !IV_CHANGESETID TYPE /AWS1/FNDCHANGESETID OPTIONAL
    !IT_SOURCEPARAMS TYPE /AWS1/CL_FNDSOURCEPARAMS_W=>TT_SOURCEPARAMS OPTIONAL
    !IT_FORMATPARAMS TYPE /AWS1/CL_FNDFORMATPARAMS_W=>TT_FORMATPARAMS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fndupdatechangesetrsp
  RAISING
    /AWS1/CX_FNDACCESSDENIEDEX
    /AWS1/CX_FNDCONFLICTEXCEPTION
    /AWS1/CX_FNDINTERNALSERVEREX
    /AWS1/CX_FNDRESOURCENOTFOUNDEX
    /AWS1/CX_FNDTHROTTLINGEX
    /AWS1/CX_FNDVALIDATIONEX
    /AWS1/CX_FNDCLIENTEXC
    /AWS1/CX_FNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_datasetid TYPE /AWS1/FNDDATASETID /AWS1/FNDDATASETID

The unique identifier for the FinSpace Dataset in which the Changeset is created.

iv_changesetid TYPE /AWS1/FNDCHANGESETID /AWS1/FNDCHANGESETID

The unique identifier for the Changeset to update.

it_sourceparams TYPE /AWS1/CL_FNDSOURCEPARAMS_W=>TT_SOURCEPARAMS TT_SOURCEPARAMS

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

Both s3SourcePath and sourceType are required attributes.

Here is an example of how you could specify the sourceParams:

"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.

it_formatparams TYPE /AWS1/CL_FNDFORMATPARAMS_W=>TT_FORMATPARAMS TT_FORMATPARAMS

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).

formatType is a required attribute and can have the following values:

  • PARQUET – Parquet source file format.

  • CSV – CSV source file format.

  • JSON – JSON source file format.

  • XML – XML source file format.

Here is an example of how you could specify the formatParams:

"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

{ "withHeader": "true", "separator": "," }

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

Optional arguments:

iv_clienttoken TYPE /AWS1/FNDCLIENTTOKEN /AWS1/FNDCLIENTTOKEN

A token that ensures idempotency. This token expires in 10 minutes.

RETURNING

oo_output TYPE REF TO /aws1/cl_fndupdatechangesetrsp /AWS1/CL_FNDUPDATECHANGESETRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatechangeset(
  it_formatparams = VALUE /aws1/cl_fndformatparams_w=>tt_formatparams(
    (
      VALUE /aws1/cl_fndformatparams_w=>ts_formatparams_maprow(
        key = |string|
        value = new /aws1/cl_fndformatparams_w( |string| )
      )
    )
  )
  it_sourceparams = VALUE /aws1/cl_fndsourceparams_w=>tt_sourceparams(
    (
      VALUE /aws1/cl_fndsourceparams_w=>ts_sourceparams_maprow(
        key = |string|
        value = new /aws1/cl_fndsourceparams_w( |string| )
      )
    )
  )
  iv_changesetid = |string|
  iv_clienttoken = |string|
  iv_datasetid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_changesetid = lo_result->get_changesetid( ).
  lv_datasetid = lo_result->get_datasetid( ).
ENDIF.