Project groups

A project group is a specified set of projectes, or a set of projectes that meet certain criteria. You can use groups to filter or display information in multiple ways, for instance by showing data from only certain projectes.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List project groups

get/objects/projects/project-group

Returns up to 100 project groups from the collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find project groups that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/projects/project-group/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/projects/project-group/3"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/projects/project-group/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a project group
post/objects/projects/project-group
Creates a new project group.


SecurityOAuth2 
Request 
Request Body schema: application/json
Creates a new project group.


id
required
string
Project or project group ID.


 
 Example:  "Projects without PO"
name
required
string
Name


 
 Example:  "Projects that are waiting on PO"
description
string or null
Description


 
 Example:  "This is a description."
groupType
string
 Default:  "all"
Group type


 Enum: "all" "specific"  
 Example:  "all"
sortOrder
string
 Default:  "ascending"
Sort Order.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
string or null
Max Matches.


 
 Example:  "10"
sortField
string
 Default:  "PROJECTID"
select sort field for project group.


 
 Example:  "PROJECTID"
isDimensionStructure
boolean
 Default:  false
If this checked, creating a dimension structure from a group enables you to add the group to the rows or columns of a financial report.


 
 Example:  false
conditionType
string
 Default:  "and"
The condition type for filters defined to create the class group.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string or null
If conditionType is expression, you can manually add the text of the expression in this field.


 
 Example:  "(1 AND 2)"
Array of objects or null
The memberFilter of the group


 
 Array 
field
string
the field


 
 Example:  "status"
operator
string
 Default:  "isOneOf"
Comparison operator.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "isOneOf"
value
string
the field


 
 Example:  "active"
Array of objects
 
 Array 
key
string
Members.


 
 Example:  "1"
id
string
Members.


 
 Example:  "DIM - BTI"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "E 01",
  • "name": "my top 01 project",
  • "description": "my top 01 project",
  • "groupType": "all",
  • "sortOrder": "descending",
  • "sortField": "PROJECTID",
  • "conditionType": "and",
  • "memberFilter": [
    • {
      • "FIELD": "PROJECTID",
      • "OPERATOR": "equals",
      • "VALUE": "8"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "E 01",
    • "href": "/objects/projects/project-group/19"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a project group
get/objects/projects/project-group/{key}
Returns detailed information for a specified project group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Top Projects",
    • "name": "Top Level Projects",
    • "description": "Top Level Projects",
    • "groupType": "specific",
    • "audit": {
      • "createdDateTime": "2016-10-26T17:28:09Z",
      • "modifiedDateTime": "2016-10-26T17:30:09Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "maxMatches": "10",
    • "sortField": "PROJECTID",
    • "expression": "(1 AND 2)",
    • "sortOrder": "ascending",
    • "groupMembers": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/projects/project-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a project group
patch/objects/projects/project-group/{key}
Updates an existing project group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


 
Request Body schema: application/json
name
string
Name


 
 Example:  "Projects that are waiting on PO"
description
string or null
Description


 
 Example:  "This is a description."
groupType
string
 Default:  "all"
Group type


 Enum: "all" "specific"  
 Example:  "all"
sortOrder
string
 Default:  "ascending"
Sort Order.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
string or null
Max Matches.


 
 Example:  "10"
sortField
string
 Default:  "PROJECTID"
select sort field for project group.


 
 Example:  "PROJECTID"
isDimensionStructure
boolean
 Default:  false
If this checked, creating a dimension structure from a group enables you to add the group to the rows or columns of a financial report.


 
 Example:  false
conditionType
string
 Default:  "and"
The condition type for filters defined to create the class group.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string or null
If conditionType is expression, you can manually add the text of the expression in this field.


 
 Example:  "(1 AND 2)"
Array of objects or null
The memberFilter of the group


 
 Array 
field
string
the field


 
 Example:  "status"
operator
string
 Default:  "isOneOf"
Comparison operator.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "isOneOf"
value
string
the field


 
 Example:  "active"
Array of objects
 
 Array 
key
string
Members.


 
 Example:  "1"
id
string
Members.


 
 Example:  "DIM - BTI"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "My Top 001 project"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "E 01",
    • "href": "/objects/projects/project-group/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a project group
delete/objects/projects/project-group/{key}
Deletes a project group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "Payload contains errors",
      • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
      • "errorId": "REST-1064",
      • "additionalInfo": {
        },
      • "details": [
        ]
      },
    • "ia::meta": {
      • "totalCount": 3,
      • "totalSuccess": 2,
      • "totalError": 1
      }
    },
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query project groups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "projects/project-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "projects-project-group",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "groupType",
    • "description",
    • "conditionType",
    • "sortOrder",
    • "maxMatches",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "23",
      • "id": "Projects without PO",
      • "name": "Projects that are waiting on PO",
      • "groupType": "specific",
      • "description": "Projects with G10 and above.",
      • "conditionType": "and",
      • "sortOrder": "ascending",
      • "maxMatches": "10",
      • "href": "/objects/projects/project-group/23"
      },
    • {
      • "key": "24",
      • "id": "Projects with Contracts",
      • "name": "Contract-based Projects",
      • "groupType": "specific",
      • "description": "Projects with contracts over $10,000.",
      • "conditionType": "or",
      • "sortOrder": "descending",
      • "maxMatches": "20",
      • "href": "/objects/projects/project-group/24"
      },
    • {
      • "key": "25",
      • "id": "Internal Projects",
      • "name": "Internal Projects Group",
      • "groupType": "specific",
      • "description": "Projects managed internally.",
      • "conditionType": "and",
      • "sortOrder": "ascending",
      • "maxMatches": "5",
      • "href": "/objects/projects/project-group/25"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}