Get all catalog objects
get
/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the catalog objects for the specified primary key.
Finder Variables- ObjectId; integer; Unique identifier of a catalog object.
- findByObjectId Finds the catalog objects for the specified Object ID.
Finder Variables- ObjectId; integer; Unique identifier of a catalog object.
- PrimaryKey Finds the catalog objects for the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- ItemDataType; string; The catalog object data type like text, number, amount, or date.
- ItemDisplayFlag; boolean; The indicator specifying if an item is displayed on the UI.
- ItemListLookup; string; The list of values that an item of type input-list is based on.
- ItemListLookupCode; string; The code for list of values that an item of type input-list is based on.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login details of user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- MeasureName; string; Name of the performance measure item in the catalog.
- ObjectDescription; string; The description of the catalog object.
- ObjectGroupNewLine; string; The indicator specifying if an item appears in a new line within a group.
- ObjectGroupOwnerPersonEmail; string; The email of the owner of a user-created group object.
- ObjectGroupOwnerPersonId; integer; The identifier of the owner of a user-created group object.
- ObjectGroupOwnerPersonName; string; The name of the owner of a user-created group object.
- ObjectGroupPublicAccess; string; The access whether a user-created group is available to others for use.
- ObjectGroupPublicAccessCode; string; The code specifying whether a user-created group is available to others for use.
- ObjectGroupSequence; integer; The sequence of items in a group.
- ObjectIcon; string; The icon of items in a group.
- ObjectId; integer; The unique identifier of a catalog object.
- ObjectLabelPosition; string; The label alignment of a catalog object like left, center, or right.
- ObjectLevel; integer; The level in an object hierarchy.
- ObjectName; string; The title of the catalog object.
- ObjectParentId; integer; The parent object identifier of the objects that are part of a group in a catalog.
- ObjectParentName; string; The parent object name of the objects that are part of a group in a catalog.
- ObjectReferenceId; integer; The catalog self-reference of the object for the group.
- ObjectType; string; The types of objects in a catalog like a group, item, and table.
- ObjectTypeCode; string; The code of object types in a catalog like a group, item, and table.
- TableColumnHeaderFive; string; The header for the fifth column of the table-type items.
- TableColumnHeaderFour; string; The header for the fourth column of the table-type items.
- TableColumnHeaderOne; string; The header for the first column of the table-type items.
- TableColumnHeaderSix; string; The header for the sixth column of the table-type items.
- TableColumnHeaderThree; string; The header for the third column of the table-type items.
- TableColumnHeaderTwo; string; The header for the second column of the table-type items.
- TableColumnTypeFive; string; The type, like text, date, number, or amount, for the fifth column of the table-type items.
- TableColumnTypeFour; string; The type, like text, date, number, or amount, for the fourth column of the table-type items.
- TableColumnTypeOne; string; The type, like text, date, number, or amount, for the first column of the table-type items.
- TableColumnTypeSix; string; The type, like text, date, number, or amount, for the sixth column of the table-type items.
- TableColumnTypeThree; string; The type, like text, date, number, or amount, for the third column of the table-type items.
- TableColumnTypeTwo; string; The type, like text, date, number, or amount, for the second column of the table-type items.
- TableDefaultSortColumn; string; The name of default column for sorting table data.
- TableDefaultSortColumnNumber; integer; The default column number for sorting table data.
- TableDefaultSortOrder; string; The default sort order, like ascending or descending, on a table column.
- TableGraphType; string; The default graph type, like bar or pie, to be rendered for a table-type item.
- TableGraphTypeCode; string; The code for default graph type which is required only for a table-type item.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectProgramCommunicationCatalogs
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectProgramCommunicationCatalogs-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ItemDataType: string
Maximum Length:
30
The catalog object data type like text, number, amount, or date. -
ItemDisplayFlag: boolean
Maximum Length:
1
Default Value:false
The indicator specifying if an item is displayed on the UI. -
ItemListLookup: string
Maximum Length:
255
The list of values that an item of type input-list is based on. -
ItemListLookupCode: string
Maximum Length:
30
The code for list of values that an item of type input-list is based on. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeasureName: string
Title:
Measure
Read Only:true
Maximum Length:240
Name of the performance measure item in the catalog. -
ObjectDescription: string
Maximum Length:
240
The description of the catalog object. -
ObjectGroupNewLine: string
Maximum Length:
1
Default Value:N
The indicator specifying if an item appears in a new line within a group. -
ObjectGroupOwnerPersonEmail: string
Maximum Length:
255
The email of the owner of a user-created group object. -
ObjectGroupOwnerPersonId: integer
(int64)
The identifier of the owner of a user-created group object.
-
ObjectGroupOwnerPersonName: string
Maximum Length:
255
The name of the owner of a user-created group object. -
ObjectGroupPublicAccess: string
Maximum Length:
255
The access whether a user-created group is available to others for use. -
ObjectGroupPublicAccessCode: string
Maximum Length:
1
The code specifying whether a user-created group is available to others for use. -
ObjectGroupSequence: integer
(int32)
The sequence of items in a group.
-
ObjectIcon: string
Maximum Length:
500
The icon of items in a group. -
ObjectId: integer
(int64)
Read Only:
true
The unique identifier of a catalog object. -
ObjectLabelPosition: string
Maximum Length:
30
The label alignment of a catalog object like left, center, or right. -
ObjectLevel: integer
(int32)
Default Value:
0
The level in an object hierarchy. -
ObjectName: string
Maximum Length:
120
The title of the catalog object. -
ObjectParentId: integer
(int64)
Default Value:
-1
The parent object identifier of the objects that are part of a group in a catalog. -
ObjectParentName: string
Maximum Length:
255
The parent object name of the objects that are part of a group in a catalog. -
ObjectReferenceId: integer
(int64)
The catalog self-reference of the object for the group.
-
ObjectType: string
Maximum Length:
255
The types of objects in a catalog like a group, item, and table. -
ObjectTypeCode: string
Maximum Length:
30
Default Value:ORA_PJS_PPC_ITEM
The code of object types in a catalog like a group, item, and table. -
TableColumnHeaderFive: string
Maximum Length:
120
The header for the fifth column of the table-type items. -
TableColumnHeaderFour: string
Maximum Length:
120
The header for the fourth column of the table-type items. -
TableColumnHeaderOne: string
Maximum Length:
120
The header for the first column of the table-type items. -
TableColumnHeaderSix: string
Maximum Length:
120
The header for the sixth column of the table-type items. -
TableColumnHeaderThree: string
Maximum Length:
120
The header for the third column of the table-type items. -
TableColumnHeaderTwo: string
Maximum Length:
120
The header for the second column of the table-type items. -
TableColumnTypeFive: string
Maximum Length:
30
The type, like text, date, number, or amount, for the fifth column of the table-type items. -
TableColumnTypeFour: string
Maximum Length:
30
The type, like text, date, number, or amount, for the fourth column of the table-type items. -
TableColumnTypeOne: string
Maximum Length:
30
The type, like text, date, number, or amount, for the first column of the table-type items. -
TableColumnTypeSix: string
Maximum Length:
30
The type, like text, date, number, or amount, for the sixth column of the table-type items. -
TableColumnTypeThree: string
Maximum Length:
30
The type, like text, date, number, or amount, for the third column of the table-type items. -
TableColumnTypeTwo: string
Maximum Length:
30
The type, like text, date, number, or amount, for the second column of the table-type items. -
TableDefaultSortColumn: string
Maximum Length:
255
The name of default column for sorting table data. -
TableDefaultSortColumnNumber: integer
(int32)
The default column number for sorting table data.
-
TableDefaultSortOrder: string
Maximum Length:
30
The default sort order, like ascending or descending, on a table column. -
TableGraphType: string
Maximum Length:
255
The default graph type, like bar or pie, to be rendered for a table-type item. -
TableGraphTypeCode: string
Maximum Length:
30
The code for default graph type which is required only for a table-type item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example
The following example shows how to get all catalog objects by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user -X GET-d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/"
Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2022-10-03T21:25:11.148+00:00", "ItemDataType": "ORA_PJS_AMOUNT", "ItemListLookupCode": null, "LastUpdateDate": "2023-04-15T00:47:25.514+00:00", "LastUpdateLogin": "-1", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "ObjectDescription": "Burdened cost from the current approved forecast", "ObjectGroupOwnerPersonId": null, "ObjectGroupPublicAccessCode": "R", "ItemDisplayFlag": false, "ObjectIcon": null, "ObjectId": "1012", "ObjectLabelPosition": "ORA_PJS_LEFT", "ObjectLevel": 0, "ObjectName": "ITD forecast cost", "ObjectGroupNewLine": "Y", "ObjectParentId": "-1", "ObjectGroupSequence": null, "ObjectTypeCode": "ORA_PJS_PPC_ITEM_COST", "TableColumnHeaderOne": null, "TableColumnHeaderTwo": null, "TableColumnHeaderThree": null, "TableColumnHeaderFour": null, "TableColumnHeaderFive": null, "TableColumnHeaderSix": null, "TableColumnTypeOne": null, "TableColumnTypeTwo": null, "TableColumnTypeThree": null, "TableColumnTypeFour": null, "TableColumnTypeFive": null, "TableColumnTypeSix": null, "TableDefaultSortColumnNumber": null, "TableDefaultSortOrder": null, "TableGraphTypeCode": null, "TableGraphType": null, "ObjectType": "Cost item", "ObjectGroupPublicAccess": "Read", "TableDefaultSortColumn": null, "ObjectParentName": null, "ObjectGroupOwnerPersonName": null, "ObjectGroupOwnerPersonEmail": null, "ItemListLookup": null, "ObjectReferenceId": null, "MeasureName": "ITD forecast cost", "@context": { "key": "1012", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1012", "name": "projectProgramCommunicationCatalogs", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1012", "name": "projectProgramCommunicationCatalogs", "kind": "item" } ] } }, { "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2022-10-03T21:25:11.148+00:00", "ItemDataType": "ORA_PJS_AMOUNT", "ItemListLookupCode": null, "LastUpdateDate": "2023-04-15T00:47:25.595+00:00", "LastUpdateLogin": "-1", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "ObjectDescription": "Burdened cost from the current approved forecast", "ObjectGroupOwnerPersonId": null, "ObjectGroupPublicAccessCode": "R", "ItemDisplayFlag": false, "ObjectIcon": null, "ObjectId": "1013", "ObjectLabelPosition": "ORA_PJS_LEFT", "ObjectLevel": 0, "ObjectName": "YTD forecast cost", "ObjectGroupNewLine": "Y", "ObjectParentId": "-1", "ObjectGroupSequence": null, "ObjectTypeCode": "ORA_PJS_PPC_ITEM_COST", "TableColumnHeaderOne": null, "TableColumnHeaderTwo": null, "TableColumnHeaderThree": null, "TableColumnHeaderFour": null, "TableColumnHeaderFive": null, "TableColumnHeaderSix": null, "TableColumnTypeOne": null, "TableColumnTypeTwo": null, "TableColumnTypeThree": null, "TableColumnTypeFour": null, "TableColumnTypeFive": null, "TableColumnTypeSix": null, "TableDefaultSortColumnNumber": null, "TableDefaultSortOrder": null, "TableGraphTypeCode": null, "TableGraphType": null, "ObjectType": "Cost item", "ObjectGroupPublicAccess": "Read", "TableDefaultSortColumn": null, "ObjectParentName": null, "ObjectGroupOwnerPersonName": null, "ObjectGroupOwnerPersonEmail": null, "ItemListLookup": null, "ObjectReferenceId": null, "MeasureName": "YTD forecast cost", "@context": { "key": "1013", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1013", "name": "projectProgramCommunicationCatalogs", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1013", "name": "projectProgramCommunicationCatalogs", "kind": "item" } ] } }, { "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2022-10-03T21:25:11.148+00:00", "ItemDataType": "ORA_PJS_PERCENT", "ItemListLookupCode": null, "LastUpdateDate": "2022-12-29T12:50:49.639+00:00", "LastUpdateLogin": "-1", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "ObjectDescription": "(Actual cost to date / current baseline budget burdened cost) * 100", "ObjectGroupOwnerPersonId": null, "ObjectGroupPublicAccessCode": "R", "ItemDisplayFlag": false, "ObjectIcon": null, "ObjectId": "1005", "ObjectLabelPosition": "ORA_PJS_LEFT", "ObjectLevel": 0, "ObjectName": "ITD actual spent cost (%)", "ObjectGroupNewLine": "Y", "ObjectParentId": "-1", "ObjectGroupSequence": null, "ObjectTypeCode": "ORA_PJS_PPC_ITEM_PROGRESS", "TableColumnHeaderOne": null, "TableColumnHeaderTwo": null, "TableColumnHeaderThree": null, "TableColumnHeaderFour": null, "TableColumnHeaderFive": null, "TableColumnHeaderSix": null, "TableColumnTypeOne": null, "TableColumnTypeTwo": null, "TableColumnTypeThree": null, "TableColumnTypeFour": null, "TableColumnTypeFive": null, "TableColumnTypeSix": null, "TableDefaultSortColumnNumber": null, "TableDefaultSortOrder": null, "TableGraphTypeCode": null, "TableGraphType": null, "ObjectType": "Progress item", "ObjectGroupPublicAccess": "Read", "TableDefaultSortColumn": null, "ObjectParentName": null, "ObjectGroupOwnerPersonName": null, "ObjectGroupOwnerPersonEmail": null, "ItemListLookup": null, "ObjectReferenceId": null, "MeasureName": "ITD actual spent cost (%)", "@context": { "key": "1005", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1005", "name": "projectProgramCommunicationCatalogs", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/1005", "name": "projectProgramCommunicationCatalogs", "kind": "item" } ] } } ], "count": 3, "hasMore": true, "limit": 3, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs", "name": "projectProgramCommunicationCatalogs", "kind": "collection" } ] }