| All Verbs | /api/objectsubscriptions/{ObjectId} |
|---|
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 ObjectSubscriptionDetailModel:
# @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
object_subscription_id: Optional[str] = None
"""
ID for the objectSubscription record.
"""
# @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
suite_data_source_instance_id: Optional[str] = None
"""
Id of the Suite DataSource Instance Id.
"""
# @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
suite_data_source_name: Optional[str] = None
"""
Suite DataSource Instance Name.
"""
# @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
rms_table_context_id: Optional[str] = None
"""
Id indicating the RmsTableCtx of the object.
"""
# @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
object_id: Optional[str] = None
"""
Id of the integrated object.
"""
# @ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
alternate_key: Optional[str] = None
"""
Unique Key of this object in the external Data Source.
"""
# @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date the object was integrated.
"""
# @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
record_status: Optional[str] = None
"""
Record Status of the object subscription.
"""
# @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
suite_instance_id: Optional[str] = None
"""
Id of the Suite Instance.
"""
# @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
suite_instance_name: Optional[str] = None
"""
Suite Instance Name.
"""
# @ApiResponse(Description="List of object subscriptions")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectSubscriptionsResponse:
object_subscriptions: Optional[List[ObjectSubscriptionDetailModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get object subscriptions for the specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectSubscriptions:
"""
Get object subscriptions for the specified object
"""
# @ApiMember(Description="Get active/inactive object subscriptions for the specified object", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Get active/inactive object subscriptions for the specified object
"""
Python GetObjectSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ObjectSubscriptions":[{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceName":"String","RmsTableContextId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","CreatedAt":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}