Difference between revisions of "Agility Web Services"

Revision as of 13:12, 3 June 2016

This section itemizes Agility Web Services, which can be used to export or import data into Agility. All available options are described in sections below.

WorkPlannerData

Web Service provided to allow getting data which are used to produced Work Planner Report in Agility. Detailed description of the web service can be found at:

Web Services Definitions page under WorkPlannerData item.

Sample XML Message

Below is the sample xml which can be passed to the WorkPlannerData web service:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://www.fastnetasp.com/GeneralImport">
   <soap:Header/>
   <soap:Body>
      <gen:WorkPlannerData>
         <!--Optional:-->
         <gen:LoginService>
            <!--Optional:-->
            <gen:login>LOGIN_NAME</gen:login>
            <!--Optional:-->
            <gen:password>PASSWORD</gen:password>
         </gen:LoginService>
         <gen:startDate>2015-01-01</gen:startDate>
         <gen:endDate>2015-12-31</gen:endDate>
         <!--Optional:-->
         <gen:reportType>Week</gen:reportType>
         <gen:includeStdJobs>false</gen:includeStdJobs>
         <gen:includeOpenWorkOrders>false</gen:includeOpenWorkOrders>
         <gen:includeCompletedWorkOrders>true</gen:includeCompletedWorkOrders>
         <!--Optional:-->
         <gen:ppmFilterExpression>maxresults -1</gen:ppmFilterExpression>
         <!--Optional:-->
         <gen:jobsFilterExpression>maxresults -1</gen:jobsFilterExpression>
         <gen:extendedData>true</gen:extendedData>
         <gen:useCachedItems>false</gen:useCachedItems>
      </gen:WorkPlannerData>
   </soap:Body>
</soap:Envelope>

Parameters description

<gen:login>

Agility valid Login name

<gen:password>

valid password for the login name entered

<gen:startDade>

Beginning of the time frame to generate the data for

<gen:endDate>

End of the time frame to generate the data for

<gen:reportType>

One of the options Day,Week,Month specifying the level of granularity for the data to generate

<gen:includeStdJobs>

If the parameter is set to true, Work Orders which are due to be generated based on the PPM definition will be included in the data

<gen:includeOpenWorkOrders>

If the parameter is set to true Open Work Orders will be include in the data

<gen:includeCompletedWorkOrders>

If the parameter is set to true Completed Work Orders will be included in the data

<gen:ppmFilterExpression>

Filter Expression string describing filtering criteria that need to be applied for PPM-related information

<gen:jobsFilterExpression>

Filter expression string describing filtering criteria that need to be applied for Work Order-related information.

<gen:extendedData>

Full set of attributes will be produced as the output of the report if the option is set to true. Only basic set of attributes will be produced otherwise.

<gen:useCachedItems>

Option can be used to speed up data generation process. It instructs the system to use cached calculations if they exist as the result of the previous call to the Web Service within the same session.

More information can be found in Work Schedule Planner report