| All Verbs | /api/objectsubscriptions/{ObjectId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get object subscriptions for the specified object
*/
@Api(Description="Get object subscriptions for the specified object")
open class GetObjectSubscriptions
{
/**
* Get active/inactive object subscriptions for the specified object
*/
@ApiMember(Description="Get active/inactive object subscriptions for the specified object", IsRequired=true, Name="ObjectId")
open var ObjectId:UUID? = null
}
@ApiResponse(Description="List of object subscriptions")
open class GetObjectSubscriptionsResponse
{
open var ObjectSubscriptions:ArrayList<ObjectSubscriptionDetailModel>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class ObjectSubscriptionDetailModel
{
/**
* ID for the objectSubscription record.
*/
@ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
open var ObjectSubscriptionId:UUID? = null
/**
* Id of the Suite DataSource Instance Id.
*/
@ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
open var SuiteDataSourceInstanceId:UUID? = null
/**
* Suite DataSource Instance Name.
*/
@ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
open var SuiteDataSourceName:String? = null
/**
* Id indicating the RmsTableCtx of the object.
*/
@ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
open var RmsTableContextId:UUID? = null
/**
* Id of the integrated object.
*/
@ApiMember(Description="Id of the integrated object.", Name="ObjectId")
open var ObjectId:UUID? = null
/**
* Unique Key of this object in the external Data Source.
*/
@ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
open var AlternateKey:String? = null
/**
* Date the object was integrated.
*/
@ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
open var CreatedAt:Date? = null
/**
* Record Status of the object subscription.
*/
@ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* Id of the Suite Instance.
*/
@ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
open var SuiteInstanceId:UUID? = null
/**
* Suite Instance Name.
*/
@ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
open var SuiteInstanceName:String? = null
}
Kotlin GetObjectSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ObjectSubscriptions:
[
{
SuiteDataSourceName: String,
AlternateKey: String,
CreatedAt: 0001-01-01,
RecordStatus: String,
SuiteInstanceName: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}