Platform API

<back to all web services

GetObjectSubscriptions

Get object subscriptions for the specified object

Requires Authentication
The following routes are available for this service:
All Verbs/api/objectsubscriptions/{ObjectId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get object subscriptions for the specified object
    */
    @Api(Description="Get object subscriptions for the specified object")
    public static 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")
        public UUID ObjectId = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetObjectSubscriptions setObjectId(UUID value) { this.ObjectId = value; return this; }
    }

    @ApiResponse(Description="List of object subscriptions")
    public static class GetObjectSubscriptionsResponse
    {
        public ArrayList<ObjectSubscriptionDetailModel> ObjectSubscriptions = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ObjectSubscriptionDetailModel> getObjectSubscriptions() { return ObjectSubscriptions; }
        public GetObjectSubscriptionsResponse setObjectSubscriptions(ArrayList<ObjectSubscriptionDetailModel> value) { this.ObjectSubscriptions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetObjectSubscriptionsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ObjectSubscriptionDetailModel
    {
        /**
        * ID for the objectSubscription record.
        */
        @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
        public UUID ObjectSubscriptionId = null;

        /**
        * Id of the Suite DataSource Instance Id.
        */
        @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * Suite DataSource Instance Name.
        */
        @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
        public String SuiteDataSourceName = null;

        /**
        * Id indicating the RmsTableCtx of the object.
        */
        @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
        public UUID RmsTableContextId = null;

        /**
        * Id of the integrated object.
        */
        @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
        public UUID ObjectId = 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")
        public String AlternateKey = null;

        /**
        * Date the object was integrated.
        */
        @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
        public Date CreatedAt = null;

        /**
        * Record Status of the object subscription.
        */
        @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
        public String RecordStatus = null;

        /**
        * Id of the Suite Instance.
        */
        @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
        public UUID SuiteInstanceId = null;

        /**
        * Suite Instance Name.
        */
        @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
        public String SuiteInstanceName = null;
        
        public UUID getObjectSubscriptionId() { return ObjectSubscriptionId; }
        public ObjectSubscriptionDetailModel setObjectSubscriptionId(UUID value) { this.ObjectSubscriptionId = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public ObjectSubscriptionDetailModel setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public String getSuiteDataSourceName() { return SuiteDataSourceName; }
        public ObjectSubscriptionDetailModel setSuiteDataSourceName(String value) { this.SuiteDataSourceName = value; return this; }
        public UUID getRmsTableContextId() { return RmsTableContextId; }
        public ObjectSubscriptionDetailModel setRmsTableContextId(UUID value) { this.RmsTableContextId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public ObjectSubscriptionDetailModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public ObjectSubscriptionDetailModel setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public ObjectSubscriptionDetailModel setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ObjectSubscriptionDetailModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public UUID getSuiteInstanceId() { return SuiteInstanceId; }
        public ObjectSubscriptionDetailModel setSuiteInstanceId(UUID value) { this.SuiteInstanceId = value; return this; }
        public String getSuiteInstanceName() { return SuiteInstanceName; }
        public ObjectSubscriptionDetailModel setSuiteInstanceName(String value) { this.SuiteInstanceName = value; return this; }
    }

}

Java GetObjectSubscriptions 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/objectsubscriptions/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}