Platform API

<back to all web services

GetDocumentationAutomation

Get details of a specific documentation automation

Requires Authentication
The following routes are available for this service:
GET/api/automation/{AutomationId}/documentation

export class AutomationModel
{
    /** @description The unique automation Id */
    // @ApiMember(Description="The unique automation Id", ParameterType="query")
    public AutomationId: string;

    /** @description The automation type Id */
    // @ApiMember(Description="The automation type Id", ParameterType="query")
    public AutomationTypeId: string;

    /** @description The automation type */
    // @ApiMember(Description="The automation type", ParameterType="query")
    public AutomationType: string;

    /** @description The object this automation applies to */
    // @ApiMember(Description="The object this automation applies to", ParameterType="query")
    public ObjectId: string;

    /** @description The object name this automation applies to */
    // @ApiMember(Description="The object name this automation applies to", ParameterType="query")
    public ObjectName: string;

    /** @description The Id of the object type that this automation applies to.  */
    // @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
    public RmsTableCtxIdObject: string;

    /** @description The name of the object type that this automation applies to. */
    // @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
    public RmsTableCtxName: string;

    /** @description A guid list containing the selected system action Id's that trigger this automation. */
    // @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
    public ActionList: string[];

    /** @description A comma separated string of the selected system action names that trigger this automation. */
    // @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
    public Actions: string;

    /** @description Name of the automation. */
    // @ApiMember(Description="Name of the automation.", ParameterType="query")
    public Name: string;

    /** @description Description of the automation */
    // @ApiMember(Description="Description of the automation", ParameterType="query")
    public Description: string;

    /** @description Owner Contact Id */
    // @ApiMember(Description="Owner Contact Id", ParameterType="query")
    public OwnerContactId: string;

    /** @description Record Status of the automation. */
    // @ApiMember(Description="Record Status of the automation.", ParameterType="query")
    public RecordStatus: string;

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

export class AutoDocumentationModel extends AutomationModel
{
    /** @description Report Id */
    // @ApiMember(Description="Report Id", ParameterType="query")
    public ReportId: string;

    /** @description Report Name */
    // @ApiMember(Description="Report Name", ParameterType="query")
    public Report: string;

    /** @description Document Type Id */
    // @ApiMember(Description="Document Type Id", ParameterType="query")
    public DocumentTypeId: string;

    /** @description Document Type */
    // @ApiMember(Description="Document Type", ParameterType="query")
    public DocumentType: string;

    /** @description Document Status Id */
    // @ApiMember(Description="Document Status Id", ParameterType="query")
    public DocumentStatusId: string;

    /** @description The Document Status */
    // @ApiMember(Description="The Document Status", ParameterType="query")
    public DocumentStatus: string;

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

// @ApiResponse(Description="Returns a documentation automation")
export class GetDocumentationAutomationResponse
{
    /** @description Documentation Automation */
    // @ApiMember(Description="Documentation Automation")
    public Automation: AutoDocumentationModel;

    public ResponseStatus: ResponseStatus;

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

/** @description Get details of a specific documentation automation */
// @Api(Description="Get details of a specific documentation automation")
export class GetDocumentationAutomation
{
    /** @description Automation Id. */
    // @ApiMember(Description="Automation Id.", ParameterType="path")
    public AutomationId: string;

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

TypeScript GetDocumentationAutomation 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.

GET /api/automation/{AutomationId}/documentation HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Automation":{"ReportId":"00000000-0000-0000-0000-000000000000","Report":"String","DocumentTypeId":"00000000-0000-0000-0000-000000000000","DocumentType":"String","DocumentStatusId":"00000000-0000-0000-0000-000000000000","DocumentStatus":"String","AutomationId":"00000000-0000-0000-0000-000000000000","AutomationTypeId":"00000000-0000-0000-0000-000000000000","AutomationType":"String","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","RmsTableCtxIdObject":"00000000-0000-0000-0000-000000000000","RmsTableCtxName":"String","ActionList":["00000000-0000-0000-0000-000000000000"],"Actions":"String","Name":"String","Description":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}