Update a status report or template content
patch
/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents/{ObjectId}
Request
Path Parameters
- ObjectId(required): integer(int64) The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
- projectProgramCommunicationsUniqID(required): string This is the hash key of the attributes which make up the composite key for the Project Program Communications resource and used to uniquely identify an instance of Project Program Communications. The client should not generate the hash key value. Instead, the client should query on the Project Program Communications collection resource in order to navigate to a specific instance of Project Program Communications to get the hash key.
Header Parameters
- Metadata-Context: string 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: string 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object- CatalogReference: string Maximum Length:
255Catalog reference of the report or template object. - CatalogReferenceId: integer (int64) Identifier for the catalog reference of the report or template object.
- ItemDataType: string Maximum Length:
30The catalog object data type like text, number, amount, or date. - ItemListLookup: string Maximum Length:
255The list of values that an item of type input-list is based on. - ItemListLookupCode: string Maximum Length:
30The code for list of values that an item of type input-list is based on. - ItemValue: string Maximum Length:
4000Data value for the report region item. - ObjectDescription: string Maximum Length:
240The description of the template or report object. - ObjectDisplay: string Maximum Length:
1Default Value:NThe indicator specifying if an item is displayed on the UI. - ObjectDisplaySequence: integer (int32) The display order of an object in the report or template.
- ObjectGroupNewLine: string Maximum Length:
1Default Value:NThe indicator specifying if an object appears in a new line in a report or template. - ObjectIcon: string Maximum Length:
500The icon details for the object in the report or template. - ObjectLabelPosition: string Maximum Length:
30The label alignment of a catalog object like left, center, or right. - ObjectLevel: integer (int32) Default Value:
0The level in an object hierarchy in a report or a template. - ObjectName: string Maximum Length:
120The title of the catalog object. - ObjectParentId: integer (int64) Default Value:
-1The parent object identifier of report or template items that are part of a group. - ObjectParentName: string Maximum Length:
255The parent object name of report or template items that are part of a group. - ObjectType: string Maximum Length:
255The types of objects like group, item, and table. - ObjectTypeCode: string Maximum Length:
30The code for types of objects like group, item, and table. - TableColumnHeaderFive: string Maximum Length:
120The header for the fifth column of the table type item. - TableColumnHeaderFour: string Maximum Length:
120The header for the fourth column of the table type item. - TableColumnHeaderOne: string Maximum Length:
120The header for the first column of the table type item. - TableColumnHeaderSix: string Maximum Length:
120The header for the sixth column of the table type item. - TableColumnHeaderThree: string Maximum Length:
120The header for the third column of the table type item. - TableColumnHeaderTwo: string Maximum Length:
120The header for the second column of the table type item. - TableColumnTypeFive: string Maximum Length:
30The type, like text, date, number, or amount, for the fifth column of the table-type items. - TableColumnTypeFour: string Maximum Length:
30The type, like text, date, number, or amount, for the fourth column of the table-type items. - TableColumnTypeOne: string Maximum Length:
30The type, like text, date, number, or amount, for the first column of the table-type items. - TableColumnTypeSix: string Maximum Length:
30The type, like text, date, number, or amount, for the sixth column of the table-type items. - TableColumnTypeThree: string Maximum Length:
30The type, like text, date, number, or amount, for the third column of the table-type items. - TableColumnTypeTwo: string Maximum Length:
30The type, like text, date, number, or amount, for the second column of the table-type items. - TableColumnValueFive: string Maximum Length:
400The value of the fifth column of the table type item. - TableColumnValueFour: string Maximum Length:
400The value of the fourth column of the table type item. - TableColumnValueOne: string Maximum Length:
400The value for the first column of the table type item. - TableColumnValueSix: string Maximum Length:
400The value for the sixth column of the table type item. - TableColumnValueThree: string Maximum Length:
400The value for the third column of the table type item. - TableColumnValueTwo: string Maximum Length:
400The value for the second column of the table type item. - TableDefaultSortColumn: string Maximum Length:
255The default column for sorting table data. - TableDefaultSortColumnNumber: integer (int32) The default column number for sorting table data.
- TableDefaultSortOrder: string Maximum Length:
30The default sort order, like ascending or descending, on a table column. - TableGraphTypeCode: string Maximum Length:
30The code for the default graph type which is required only for a table-type item like bar or pie graph. - TableGraphTypeName: string Maximum Length:
255The default graph type, like bar or pie, to be rendered for a table-type item.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
- 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.
Root Schema : projectProgramCommunications-Contents-item-response
Type:
Show Source object- CatalogReference: string Maximum Length:
255Catalog reference of the report or template object. - CatalogReferenceId: integer (int64) Identifier for the catalog reference of the report or template object.
- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - ItemDataType: string Maximum Length:
30The catalog object data type like text, number, amount, or date. - ItemListLookup: string Maximum Length:
255The list of values that an item of type input-list is based on. - ItemListLookupCode: string Maximum Length:
30The code for list of values that an item of type input-list is based on. - ItemValue: string Maximum Length:
4000Data value for the report region item. - LastUpdateDate: string (date-time) Read Only:
trueThe date when the record was last updated. - LastUpdatedBy: string Read Only:
trueMaximum Length:64The user who last updated the record. - LastUpdateLogin: string Read Only:
trueMaximum Length:32The login details of user who last updated the record. - links: array Links Title:
LinksThe link relations associated with the resource instance. - ObjectDescription: string Maximum Length:
240The description of the template or report object. - ObjectDisplay: string Maximum Length:
1Default Value:NThe indicator specifying if an item is displayed on the UI. - ObjectDisplaySequence: integer (int32) The display order of an object in the report or template.
- ObjectGroupNewLine: string Maximum Length:
1Default Value:NThe indicator specifying if an object appears in a new line in a report or template. - ObjectIcon: string Maximum Length:
500The icon details for the object in the report or template. - ObjectId: integer (int64) Read Only:
trueThe unique identifier of an object within the report or template. - ObjectLabelPosition: string Maximum Length:
30The label alignment of a catalog object like left, center, or right. - ObjectLevel: integer (int32) Default Value:
0The level in an object hierarchy in a report or a template. - ObjectName: string Maximum Length:
120The title of the catalog object. - ObjectParentId: integer (int64) Default Value:
-1The parent object identifier of report or template items that are part of a group. - ObjectParentName: string Maximum Length:
255The parent object name of report or template items that are part of a group. - ObjectType: string Maximum Length:
255The types of objects like group, item, and table. - ObjectTypeCode: string Maximum Length:
30The code for types of objects like group, item, and table. - TableColumnHeaderFive: string Maximum Length:
120The header for the fifth column of the table type item. - TableColumnHeaderFour: string Maximum Length:
120The header for the fourth column of the table type item. - TableColumnHeaderOne: string Maximum Length:
120The header for the first column of the table type item. - TableColumnHeaderSix: string Maximum Length:
120The header for the sixth column of the table type item. - TableColumnHeaderThree: string Maximum Length:
120The header for the third column of the table type item. - TableColumnHeaderTwo: string Maximum Length:
120The header for the second column of the table type item. - TableColumnTypeFive: string Maximum Length:
30The type, like text, date, number, or amount, for the fifth column of the table-type items. - TableColumnTypeFour: string Maximum Length:
30The type, like text, date, number, or amount, for the fourth column of the table-type items. - TableColumnTypeOne: string Maximum Length:
30The type, like text, date, number, or amount, for the first column of the table-type items. - TableColumnTypeSix: string Maximum Length:
30The type, like text, date, number, or amount, for the sixth column of the table-type items. - TableColumnTypeThree: string Maximum Length:
30The type, like text, date, number, or amount, for the third column of the table-type items. - TableColumnTypeTwo: string Maximum Length:
30The type, like text, date, number, or amount, for the second column of the table-type items. - TableColumnValueFive: string Maximum Length:
400The value of the fifth column of the table type item. - TableColumnValueFour: string Maximum Length:
400The value of the fourth column of the table type item. - TableColumnValueOne: string Maximum Length:
400The value for the first column of the table type item. - TableColumnValueSix: string Maximum Length:
400The value for the sixth column of the table type item. - TableColumnValueThree: string Maximum Length:
400The value for the third column of the table type item. - TableColumnValueTwo: string Maximum Length:
400The value for the second column of the table type item. - TableDefaultSortColumn: string Maximum Length:
255The default column for sorting table data. - TableDefaultSortColumnNumber: integer (int32) The default column number for sorting table data.
- TableDefaultSortOrder: string Maximum Length:
30The default sort order, like ascending or descending, on a table column. - TableGraphTypeCode: string Maximum Length:
30The code for the default graph type which is required only for a table-type item like bar or pie graph. - TableGraphTypeName: string Maximum Length:
255The default graph type, like bar or pie, to be rendered for a table-type item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed 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.