Create a catalog object
post
/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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. -
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.
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 : 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.