cancel
Showing results for 
Search instead for 
Did you mean: 

Definition of all API fields

vervinckt_joyca
Active Contributor
0 Kudos

Hello,

I am wondering if there is somewhere a documentation of what all fields in an API actually mean or what they are meant for.

A field like "InteractionType" is quite obvious; but if you look in the metadata of e.g. API_MKT_INTERACTION_SRV there are a lot of fields that I wonder about what they are meant for. Like "InteractionSourceObjectAddlID". Or "InteractionStatus". Or "PrecedingInteractionUUID". Just to name a few. Also the "InteractionContent" attribute, I happen to know that this one is meant for long text where SentimentAnalysis can run on, but I also don't find it documented officially that that is indeed the purpose of that field.

So do you know if such a list exists somewhere?

Thanks

Joyca

Accepted Solutions (1)

Accepted Solutions (1)

JoanGarloff
Advisor
Advisor
0 Kudos

Hi Joyca,

Using the URL mentioned n the documentation (table in title topic)

https://:/sap/opu/odata/SAP/API_MKT_INTERACTION_SRV/$metadata?sap-documentation=all you can access an XML file with documentation for the fields. Currently not all fields are documented, we are working on this. Best regards,

Joan

vervinckt_joyca
Active Contributor
0 Kudos

Thanks Joan,

good to hear that this is a work in progress, currently indeed not many fields have an additional description when calling this file.

Kr

Joyca

Answers (2)

Answers (2)

rolf_schumann
Explorer
0 Kudos

Dear Joyca,

For now please check whether the field is in the description for the CSV upload with its technical, but similar name (for example SOURCE_OBJECT_ADD_ID instead of InteractionSourceObjectAddlID): https://help.sap.com/viewer/ac1eab4c66bc490da7ac2c378c46b0e7/1808.500/en-US/7dd16e5458548c4ce1000000....

Best regards,

Rolf

former_member247020
Active Participant
0 Kudos

Hi Joyca,

you can also use the SAP API Hub to browse and test the available APIs. The documentation it not complete for all APIs but this gives you a good start to explore the APIs. The API Hub shows you the fields available for a specific operation.

Select the API e.g. Interaction API and change from "Example Value" to "Model" view. There you find a description on field level.

https://api.sap.com/api/API_MKT_INTERACTION_SRV/resource

br,

Johannes

vervinckt_joyca
Active Contributor
0 Kudos

Thanks Johannes, though for many fields I still think this model view gives more a long text than really a description. e.g. "InteractionStatus": Status for API-Services... Does not explain what this actually means, what it does, where you can find this back in the Marketing frontend; ...

Idem "InteractionContent"; Interaction Content is the description. Also doesn't explain that this is meant for very long texts and the sentiment analysis.

Kr

Joyca