Platform Subscription API

<back to all web services

SaveCustomContentFWECM

Saves Framework ECM data into EROS for linked objects.

Requires Authentication
The following routes are available for this service:
All Verbs/api/rmsdataexchange/bulk/project
All Verbs/api/rmsdataexchange/bulk/contact
All Verbs/api/rmsdataexchange/bulk/lead
All Verbs/api/rmsdataexchange/bulk/opportunity
All Verbs/api/rmsdataexchange/bulk/prospect
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionCustomContentModel:
    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="Guid", Description="Eros RmsTableCtxId of the object we are saving custom content to.", IsRequired=true, Name="RmsTableCtxId")
    rms_table_ctx_id: Optional[str] = None
    """
    Eros RmsTableCtxId of the object we are saving custom content to.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", Name="AlternateKey")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the object on the external system.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId")
    object_id: Optional[str] = None
    """
    Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
    """


    ignore_validation: bool = False
    # @ApiMember(DataType="int", Description="RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros.", IsRequired=true, Name="RmsFieldCtxId")
    rms_field_ctx_id: int = 0
    """
    RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros.
    """


    # @ApiMember(DataType="string", Description="Value to be saved for the object.", Name="Value")
    value: Optional[str] = None
    """
    Value to be saved for the object.
    """


    licensee_id: Optional[str] = None
    session_id: Optional[str] = None


# @Api(Description="Saves Framework ECM data into EROS for linked objects.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveCustomContentFWECM:
    """
    Saves Framework ECM data into EROS for linked objects.
    """

    # @ApiMember(DataType="List<SubscriptionCustomContentModel>", Description="To pass bulk upload of data to save for objects.", IsRequired=true, Name="CustomContents")
    custom_contents: List[SubscriptionCustomContentModel] = field(default_factory=list)
    """
    To pass bulk upload of data to save for objects.
    """

Python SaveCustomContentFWECM DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/rmsdataexchange/bulk/project HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CustomContents":[{"AlternateKey":"String","IgnoreValidation":false,"RmsFieldCtxId":0,"Value":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}