Jump to

• Request
• Response

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

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectProgramCommunicationCatalogs-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectProgramCommunicationCatalogs-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectProgramCommunicationCatalogs-item-response"
    }
}

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 : projectProgramCommunicationCatalogs-item-response

Type: object

Show Source

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

{
    "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
        },
        "ObjectGroupOwnerPersonId":{
            "type":"integer",
            "description":"The identifier of the owner of a user-created group object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TableColumnHeaderFive":{
            "maxLength":"120",
            "type":"string",
            "description":"The header for the fifth column of the table-type items.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectParentName":{
            "maxLength":"255",
            "type":"string",
            "description":"The parent object name of the objects that are part of a group in a catalog.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectParentId"
                ]
            },
            "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
        },
        "TableGraphType":{
            "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
        },
        "ObjectTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of object types in a catalog like a group, item, and table.",
            "nullable":false,
            "default":"ORA_PJS_PPC_ITEM",
            "x-queryable":true
        },
        "TableGraphTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for default graph type which is required only for a table-type item.",
            "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 items.",
            "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
        },
        "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
        },
        "ObjectGroupSequence":{
            "type":"integer",
            "description":"The sequence of items in a group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The types of objects in a catalog like a 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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectParentId":{
            "type":"integer",
            "description":"The parent object identifier of the objects that are part of a group in a catalog.",
            "format":"int64",
            "nullable":false,
            "default":"-1",
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TableColumnHeaderThree":{
            "maxLength":"120",
            "type":"string",
            "description":"The header for the third column of the table-type items.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectIcon":{
            "maxLength":"500",
            "type":"string",
            "description":"The icon of items in a group.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectGroupOwnerPersonName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the owner of a user-created group object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectReferenceId":{
            "type":"integer",
            "description":"The catalog self-reference of the object for the group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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 item appears in a new line within a group.",
            "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 items.",
            "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 a catalog object.",
            "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 items.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectGroupPublicAccess":{
            "maxLength":"255",
            "type":"string",
            "description":"The access whether a user-created group is available to others for use.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectGroupPublicAccessCode"
                ]
            },
            "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
        },
        "MeasureName":{
            "title":"Measure",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the performance measure item in the catalog.",
            "nullable":false,
            "readOnly":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
        },
        "ItemDisplayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The indicator specifying if an item is displayed on the UI.",
            "nullable":false,
            "default":false,
            "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 name of 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
        },
        "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
        },
        "TableColumnHeaderFour":{
            "maxLength":"120",
            "type":"string",
            "description":"The header for the fourth column of the table-type items.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"The description of the catalog object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectGroupPublicAccessCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The code specifying whether a user-created group is available to others for use.",
            "nullable":false,
            "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
        },
        "ObjectGroupOwnerPersonEmail":{
            "maxLength":"255",
            "type":"string",
            "description":"The email of the owner of a user-created group object.",
            "nullable":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