Platform API

<back to all web services

GetDocumentationAutomation

Get details of a specific documentation automation

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

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

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

<GetDocumentationAutomationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Automation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ActionList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ActionList>
    <d2p1:Actions>String</d2p1:Actions>
    <d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
    <d2p1:AutomationType>String</d2p1:AutomationType>
    <d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:ObjectName>String</d2p1:ObjectName>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
    <d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
    <d2p1:DocumentStatus>String</d2p1:DocumentStatus>
    <d2p1:DocumentStatusId>00000000-0000-0000-0000-000000000000</d2p1:DocumentStatusId>
    <d2p1:DocumentType>String</d2p1:DocumentType>
    <d2p1:DocumentTypeId>00000000-0000-0000-0000-000000000000</d2p1:DocumentTypeId>
    <d2p1:Report>String</d2p1:Report>
    <d2p1:ReportId>00000000-0000-0000-0000-000000000000</d2p1:ReportId>
  </Automation>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDocumentationAutomationResponse>