Jump to

• Request
• Response

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:
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CatalogReference: string
  Maximum Length: 255

  Catalog 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: 30

  The catalog object data type like text, number, amount, or date.
• 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.
• ItemValue: string
  Maximum Length: 4000

  Data value for the report region item.
• ObjectDescription: string
  Maximum Length: 240

  The description of the template or report object.
• ObjectDisplay: string
  Maximum Length: 1

  Default Value: N

  The 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: 1

  Default Value: N

  The indicator specifying if an object appears in a new line in a report or template.
• ObjectIcon: string
  Maximum Length: 500

  The icon details for the object in the report or template.
• 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 in a report or a template.
• ObjectName: string
  Maximum Length: 120

  The title of the catalog object.
• ObjectParentId: integer (int64)
  Default Value: -1

  The parent object identifier of report or template items that are part of a group.
• ObjectParentName: string
  Maximum Length: 255

  The parent object name of report or template items that are part of a group.
• ObjectType: string
  Maximum Length: 255

  The types of objects like group, item, and table.
• ObjectTypeCode: string
  Maximum Length: 30

  The code for types of objects like group, item, and table.
• TableColumnHeaderFive: string
  Maximum Length: 120

  The header for the fifth column of the table type item.
• TableColumnHeaderFour: string
  Maximum Length: 120

  The header for the fourth column of the table type item.
• TableColumnHeaderOne: string
  Maximum Length: 120

  The header for the first column of the table type item.
• TableColumnHeaderSix: string
  Maximum Length: 120

  The header for the sixth column of the table type item.
• TableColumnHeaderThree: string
  Maximum Length: 120

  The header for the third column of the table type item.
• TableColumnHeaderTwo: string
  Maximum Length: 120

  The header for the second column of the table type item.
• 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.
• TableColumnValueFive: string
  Maximum Length: 400

  The value of the fifth column of the table type item.
• TableColumnValueFour: string
  Maximum Length: 400

  The value of the fourth column of the table type item.
• TableColumnValueOne: string
  Maximum Length: 400

  The value for the first column of the table type item.
• TableColumnValueSix: string
  Maximum Length: 400

  The value for the sixth column of the table type item.
• TableColumnValueThree: string
  Maximum Length: 400

  The value for the third column of the table type item.
• TableColumnValueTwo: string
  Maximum Length: 400

  The value for the second column of the table type item.
• TableDefaultSortColumn: string
  Maximum Length: 255

  The 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.
• TableGraphTypeCode: string
  Maximum Length: 30

  The code for the default graph type which is required only for a table-type item like bar or pie graph.
• TableGraphTypeName: string
  Maximum Length: 255

  The default graph type, like bar or pie, to be rendered for a table-type item.

{
    "type":"object",
    "properties":{
        "TableColumnTypeSix":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the sixth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TableColumnHeaderFive":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the fifth column of the table type item.",
            "nullable":true
        },
        "ObjectParentName":{
            "maxLength":255,
            "type":"string",
            "description":"The parent object name of report or template items that are part of a group.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectParentId"
                ]
            }
        },
        "TableColumnValueTwo":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the second column of the table type item.",
            "nullable":true
        },
        "TableColumnValueThree":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the third column of the table type item.",
            "nullable":true
        },
        "TableColumnValueFive":{
            "maxLength":400,
            "type":"string",
            "description":"The value of the fifth column of the table type item.",
            "nullable":true
        },
        "TableColumnTypeFive":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the fifth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for types of objects like group, item, and table.",
            "nullable":false
        },
        "TableGraphTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the default graph type which is required only for a table-type item like bar or pie graph.",
            "nullable":true
        },
        "TableDefaultSortColumnNumber":{
            "type":"integer",
            "description":"The default column number for sorting table data.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "TableColumnHeaderTwo":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the second column of the table type item.",
            "nullable":true
        },
        "TableColumnTypeOne":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the first column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TableColumnValueFour":{
            "maxLength":400,
            "type":"string",
            "description":"The value of the fourth column of the table type item.",
            "nullable":true
        },
        "ItemListLookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for list of values that an item of type input-list is based on.",
            "nullable":true
        },
        "TableColumnTypeFour":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the fourth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectType":{
            "maxLength":255,
            "type":"string",
            "description":"The types of objects like group, item, and table.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectTypeCode"
                ]
            }
        },
        "ObjectLevel":{
            "type":"integer",
            "description":"The level in an object hierarchy in a report or a template.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectParentId":{
            "type":"integer",
            "description":"The parent object identifier of report or template items that are part of a group.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "TableColumnHeaderThree":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the third column of the table type item.",
            "nullable":true
        },
        "ObjectDisplaySequence":{
            "type":"integer",
            "description":"The display order of an object in the report or template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectDisplay":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator specifying if an item is displayed on the UI.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectIcon":{
            "maxLength":500,
            "type":"string",
            "description":"The icon details for the object in the report or template.",
            "nullable":true
        },
        "CatalogReferenceId":{
            "type":"integer",
            "description":"Identifier for the catalog reference of the report or template object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "ObjectGroupNewLine":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator specifying if an object appears in a new line in a report or template.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TableColumnHeaderSix":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the sixth column of the table type item.",
            "nullable":true
        },
        "TableColumnHeaderOne":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the first column of the table type item.",
            "nullable":true
        },
        "TableColumnValueOne":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the first column of the table type item.",
            "nullable":true
        },
        "ItemListLookup":{
            "maxLength":255,
            "type":"string",
            "description":"The list of values that an item of type input-list is based on.",
            "nullable":true
        },
        "TableColumnValueSix":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the sixth column of the table type item.",
            "nullable":true
        },
        "TableColumnTypeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the second column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectLabelPosition":{
            "maxLength":30,
            "type":"string",
            "description":"The label alignment of a catalog object like left, center, or right.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectName":{
            "maxLength":120,
            "type":"string",
            "description":"The title of the catalog object.",
            "nullable":false
        },
        "TableDefaultSortColumn":{
            "maxLength":255,
            "type":"string",
            "description":"The default column for sorting table data.",
            "nullable":true
        },
        "TableDefaultSortOrder":{
            "maxLength":30,
            "type":"string",
            "description":"The default sort order, like ascending or descending, on a table column.",
            "nullable":true
        },
        "TableGraphTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"The default graph type, like bar or pie, to be rendered for a table-type item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TableGraphTypeCode"
                ]
            }
        },
        "ItemDataType":{
            "maxLength":30,
            "type":"string",
            "description":"The catalog object data type like text, number, amount, or date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Data value for the report region item.",
            "nullable":true
        },
        "TableColumnHeaderFour":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the fourth column of the table type item.",
            "nullable":true
        },
        "CatalogReference":{
            "maxLength":255,
            "type":"string",
            "description":"Catalog reference of the report or template object.",
            "nullable":true
        },
        "ObjectDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the template or report object.",
            "nullable":true
        },
        "TableColumnTypeThree":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the third column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : projectProgramCommunications-Contents-item-response

Type: object

Show Source

• CatalogReference: string
  Maximum Length: 255

  Catalog 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: 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.
• 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.
• ItemValue: string
  Maximum Length: 4000

  Data value for the report region item.
• 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.
• ObjectDescription: string
  Maximum Length: 240

  The description of the template or report object.
• ObjectDisplay: string
  Maximum Length: 1

  Default Value: N

  The 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: 1

  Default Value: N

  The indicator specifying if an object appears in a new line in a report or template.
• ObjectIcon: string
  Maximum Length: 500

  The icon details for the object in the report or template.
• ObjectId: integer (int64)
  Read Only: true

  The unique identifier of an object within the report or template.
• 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 in a report or a template.
• ObjectName: string
  Maximum Length: 120

  The title of the catalog object.
• ObjectParentId: integer (int64)
  Default Value: -1

  The parent object identifier of report or template items that are part of a group.
• ObjectParentName: string
  Maximum Length: 255

  The parent object name of report or template items that are part of a group.
• ObjectType: string
  Maximum Length: 255

  The types of objects like group, item, and table.
• ObjectTypeCode: string
  Maximum Length: 30

  The code for types of objects like group, item, and table.
• TableColumnHeaderFive: string
  Maximum Length: 120

  The header for the fifth column of the table type item.
• TableColumnHeaderFour: string
  Maximum Length: 120

  The header for the fourth column of the table type item.
• TableColumnHeaderOne: string
  Maximum Length: 120

  The header for the first column of the table type item.
• TableColumnHeaderSix: string
  Maximum Length: 120

  The header for the sixth column of the table type item.
• TableColumnHeaderThree: string
  Maximum Length: 120

  The header for the third column of the table type item.
• TableColumnHeaderTwo: string
  Maximum Length: 120

  The header for the second column of the table type item.
• 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.
• TableColumnValueFive: string
  Maximum Length: 400

  The value of the fifth column of the table type item.
• TableColumnValueFour: string
  Maximum Length: 400

  The value of the fourth column of the table type item.
• TableColumnValueOne: string
  Maximum Length: 400

  The value for the first column of the table type item.
• TableColumnValueSix: string
  Maximum Length: 400

  The value for the sixth column of the table type item.
• TableColumnValueThree: string
  Maximum Length: 400

  The value for the third column of the table type item.
• TableColumnValueTwo: string
  Maximum Length: 400

  The value for the second column of the table type item.
• TableDefaultSortColumn: string
  Maximum Length: 255

  The 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.
• TableGraphTypeCode: string
  Maximum Length: 30

  The code for the default graph type which is required only for a table-type item like bar or pie graph.
• TableGraphTypeName: string
  Maximum Length: 255

  The default graph type, like bar or pie, to be rendered for a table-type item.

{
    "type":"object",
    "properties":{
        "TableColumnTypeSix":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the sixth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TableColumnHeaderFive":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the fifth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectParentName":{
            "maxLength":255,
            "type":"string",
            "description":"The parent object name of report or template items that are part of a group.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectParentId"
                ]
            },
            "x-queryable":true
        },
        "TableColumnValueTwo":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the second column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnValueThree":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the third column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnValueFive":{
            "maxLength":400,
            "type":"string",
            "description":"The value of the fifth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnTypeFive":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the fifth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for types of objects like group, item, and table.",
            "nullable":false,
            "x-queryable":true
        },
        "TableGraphTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the default graph type which is required only for a table-type item like bar or pie graph.",
            "nullable":true,
            "x-queryable":true
        },
        "TableDefaultSortColumnNumber":{
            "type":"integer",
            "description":"The default column number for sorting table data.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TableColumnHeaderTwo":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the second column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnTypeOne":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the first column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TableColumnValueFour":{
            "maxLength":400,
            "type":"string",
            "description":"The value of the fourth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemListLookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for list of values that an item of type input-list is based on.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnTypeFour":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the fourth column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":255,
            "type":"string",
            "description":"The types of objects like group, item, and table.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ObjectLevel":{
            "type":"integer",
            "description":"The level in an object hierarchy in a report or a template.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectParentId":{
            "type":"integer",
            "description":"The parent object identifier of report or template items that are part of a group.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TableColumnHeaderThree":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the third column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectDisplaySequence":{
            "type":"integer",
            "description":"The display order of an object in the report or template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectDisplay":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator specifying if an item is displayed on the UI.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectIcon":{
            "maxLength":500,
            "type":"string",
            "description":"The icon details for the object in the report or template.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogReferenceId":{
            "type":"integer",
            "description":"Identifier for the catalog reference of the report or template object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectGroupNewLine":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator specifying if an object appears in a new line in a report or template.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TableColumnHeaderSix":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the sixth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of an object within the report or template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TableColumnHeaderOne":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the first column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnValueOne":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the first column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemListLookup":{
            "maxLength":255,
            "type":"string",
            "description":"The list of values that an item of type input-list is based on.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnValueSix":{
            "maxLength":400,
            "type":"string",
            "description":"The value for the sixth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnTypeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the second column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectLabelPosition":{
            "maxLength":30,
            "type":"string",
            "description":"The label alignment of a catalog object like left, center, or right.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":120,
            "type":"string",
            "description":"The title of the catalog object.",
            "nullable":false,
            "x-queryable":true
        },
        "TableDefaultSortColumn":{
            "maxLength":255,
            "type":"string",
            "description":"The default column for sorting table data.",
            "nullable":true,
            "x-queryable":true
        },
        "TableDefaultSortOrder":{
            "maxLength":30,
            "type":"string",
            "description":"The default sort order, like ascending or descending, on a table column.",
            "nullable":true,
            "x-queryable":true
        },
        "TableGraphTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"The default graph type, like bar or pie, to be rendered for a table-type item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TableGraphTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ItemDataType":{
            "maxLength":30,
            "type":"string",
            "description":"The catalog object data type like text, number, amount, or date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Data value for the report region item.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnHeaderFour":{
            "maxLength":120,
            "type":"string",
            "description":"The header for the fourth column of the table type item.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogReference":{
            "maxLength":255,
            "type":"string",
            "description":"Catalog reference of the report or template object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the template or report object.",
            "nullable":true,
            "x-queryable":true
        },
        "TableColumnTypeThree":{
            "maxLength":30,
            "type":"string",
            "description":"The type, like text, date, number, or amount, for the third column of the table-type items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top