Platform API

GetRelatedItems

Get related items related to the specified object.

The following routes are available for this service:
All Verbs	/api/relateditems/{ObjectId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get related items related to the specified object.
*/
@Api(Description="Get related items related to the specified object.")
open class GetRelatedItems : PagedModel()
{
    /**
    * Object to get related items for.
    */
    @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null

    /**
    * Significant Only or All
    */
    @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
    open var RelatedItemsLevel:UUID? = null

    /**
    * Return all connections or paged results?
    */
    @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    open var IsPagedMode:Boolean? = null
}

open class PagedModel
{
    /**
    * Page Number to retrieve
    */
    @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    open var PageNumber:Int? = null

    /**
    * Number of records to retrieve
    */
    @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    open var PageSize:Int? = null

    /**
    * Index of field to sort results by
    */
    @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    open var SortIndex:Int? = null

    /**
    * Sort Order - Ascending or Descending
    */
    @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    open var SortOrder:SortOrder? = null
}

enum class SortOrder
{
    Ascending,
    Descending,
}

@ApiResponse(Description="Items related to the object.")
open class GetRelatedItemsResponse
{
    open var RelatedItems:ArrayList<RelatedItemsModel>? = null
    open var TotalRelatedItems:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class RelatedItemsModel
{
    /**
    * Object linked to the related item.
    */
    @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null

    /**
    * Related item name.
    */
    @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
    open var RelatedItemName:String? = null

    /**
    * Related item type.
    */
    @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
    open var RelatedItemType:String? = null

    /**
    * Date of creation of the related item.
    */
    @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
    open var CreatedAt:Date? = null

    /**
    * Contact who created the related item
    */
    @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
    open var CreatedByName:String? = null

    /**
    * Contact who created the related item
    */
    @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
    open var CreatedById:UUID? = null

    /**
    * Profile photo of the contact who created the related item
    */
    @ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")
    open var CreatedByThumbnailUrl:String? = null

    /**
    * Relationship between objects linked to the related item
    */
    @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
    open var Relationship:String? = null

    /**
    * Is the related item significant?
    */
    @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
    open var IsSignificant:Boolean? = null
}

Kotlin GetRelatedItems DTOs

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

HTTP + CSV

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

POST /api/relateditems/{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","RelatedItemsLevel":"00000000-0000-0000-0000-000000000000","IsPagedMode":false,"PageNumber":0,"PageSize":0,"SortIndex":0,"SortOrder":"Ascending"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"RelatedItems":[{"ObjectId":"00000000-0000-0000-0000-000000000000","RelatedItemName":"String","RelatedItemType":"String","CreatedAt":"0001-01-01T00:00:00.0000000","CreatedByName":"String","CreatedById":"00000000-0000-0000-0000-000000000000","CreatedByThumbnailUrl":"String","Relationship":"String","IsSignificant":false}],"TotalRelatedItems":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}