Platform API

<back to all web services

GetRelatedItems

Get related items related to the specified object.

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

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

    public constructor(init?: Partial<PagedModel>) { (Object as any).assign(this, init); }
}

export class RelatedItemsModel
{
    /** @description Object linked to the related item. */
    // @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description Related item name. */
    // @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
    public RelatedItemName: string;

    /** @description Related item type. */
    // @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
    public RelatedItemType: string;

    /** @description Date of creation of the related item. */
    // @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
    public CreatedAt: string;

    /** @description Contact who created the related item */
    // @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
    public CreatedByName: string;

    /** @description Contact who created the related item */
    // @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
    public CreatedById: string;

    /** @description 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")
    public CreatedByThumbnailUrl: string;

    /** @description Relationship between objects linked to the related item */
    // @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
    public Relationship: string;

    /** @description Is the related item significant? */
    // @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
    public IsSignificant: boolean;

    public constructor(init?: Partial<RelatedItemsModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Items related to the object.")
export class GetRelatedItemsResponse
{
    public RelatedItems: RelatedItemsModel[];
    public TotalRelatedItems: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetRelatedItemsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get related items related to the specified object. */
// @Api(Description="Get related items related to the specified object.")
export class GetRelatedItems extends PagedModel
{
    /** @description Object to get related items for. */
    // @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description Significant Only or All */
    // @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
    public RelatedItemsLevel: string;

    /** @description Return all connections or paged results? */
    // @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    public IsPagedMode: boolean;

    public constructor(init?: Partial<GetRelatedItems>) { super(init); (Object as any).assign(this, init); }
}

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

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