Examples of queries by ScheduleState

Products

• Rally On-Premise
• Rally SaaS

Issue/Introduction

A user queries by "Schedule State" and does not see expected results.

Resolution

The name of the field must be spelled exactly as it appears in the Web Services API document: two capital letters in the beginning of each word, and no spaces.

 

Notice that the ScheduleState field is inherited by HierarchicalRequirement or Defect objects from SchedulableArtifact abstract type, which is a child type of Artifacat abstract type.

Below is an example of a query in a custom grid:
((ScheduleState != Accepted)AND(ScheduleState != Completed))

 

And the data returned:

The identical result is returned by a simpler query that uses less than operator:

(ScheduleState < Completed)

One of the custom grid's limitations is that its results are limited to one page, and the max page size is 200 (default 20). If you expect more results than 200, a custom app written with AppSDK2 may be more appropriate as long as you are comfortable with javascript or can leverage internal resources for that. Another option is to issue queries directly in the WS API interactive document:
The screenshot below shows a query:
(ScheduleState != Accepted)

Here is the result:

An equivalent of this query is this URL, modified to fetch Parent and Iteration fields can be pasted directly in the browser's address bar. Make sure to use workspace ObjectID valid in your subscription, and not?

https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/<WORKSPACE_OID>&query=(ScheduleState != Accepted)&pagesize=200&fetch=Parent,Iteration

Here is a fragment of a result that shows one of the returned objects:

• {

  • _rallyAPIMajor: "2",
  • _rallyAPIMinor: "0",
  • _ref: "https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement/<STORY_OID>",
  • _refObjectUUID: "<OBJECT_UUID>",
  • _objectVersion: "3",
  • _refObjectName: "y1",
  • Iteration:

    ?

    {

    • _rallyAPIMajor: "2",
    • _rallyAPIMinor: "0",
    • _ref: "https://rally1.rallydev.com/slm/webservice/v2.0/iteration/<ITERATION_OID>",
    • _refObjectUUID: "<OBJECT_UUID>",
    • _objectVersion: "1",
    • _refObjectName: "i1",
    • _type: "Iteration"

    },
  • Project:

    ?

    {},
  • Parent:

    ?

    {

    • _rallyAPIMajor: "2",
    • _rallyAPIMinor: "0",
    • _ref: "https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement/<STORY_OID>",
    • _refObjectUUID: "<OBJECT_UIID>",
    • _objectVersion: "4",
    • _refObjectName: "y",
    • Iteration: null,
    • Project:

      ?

      {},
    • _type: "HierarchicalRequirement"

    },
  • _type: "HierarchicalRequirement"

  },

If you need to page add start query parameter. This example shows the query that returns the second page of the results. Since max page size is 200, the second page starts with index 201:

https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/<WORKSPACE_OID>&query=(ScheduleState != Accepted)&pagesize=200&fetch=Parent,Iteration&start=201