Update a catalog resource
patch
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs/{ResourceName}
Request
Path Parameters
-
ResourceId(required): string
The unique identifier for the resource.
-
ResourceName(required): string
The unique resource name to identify a resource.
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
Root Schema : schema
Type:
Show Source
object
-
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N. -
IsOfflineSupportRequired: string
Maximum Length:
1
Indicates if offline support is required. -
IsSearchEnabled: string
Maximum Length:
1
Indicates if search is enabled. -
ModuleId: string
Maximum Length:
32
The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PromptEnabled: string
Maximum Length:
1
Indicates if this REST resource is prompt-enabled. -
Querysource: string
Maximum Length:
1
Indicates if the resource ID can be used as a primary or a related object in a custom query. -
Reportable: string
Maximum Length:
1
Indicates if a resource ID can be used in reporting tools as a data source. -
ResourceId: string
Maximum Length:
50
The unique identifier for a resource. -
ResourceName: string
Maximum Length:
256
The unique resource name to identify a resource. -
RestEndPoint: string
Maximum Length:
1000
The REST end point. -
SeedDataLock: integer
(int32)
Default Value:
1
The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified. -
Version: string
Maximum Length:
20
The REST version number.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorApplicationIdTypes-Catalogs-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the row was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N. -
IsOfflineSupportRequired: string
Maximum Length:
1
Indicates if offline support is required. -
IsSearchEnabled: string
Maximum Length:
1
Indicates if search is enabled. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PromptEnabled: string
Maximum Length:
1
Indicates if this REST resource is prompt-enabled. -
Querysource: string
Maximum Length:
1
Indicates if the resource ID can be used as a primary or a related object in a custom query. -
Reportable: string
Maximum Length:
1
Indicates if a resource ID can be used in reporting tools as a data source. -
ResourceId: string
Maximum Length:
50
The unique identifier for a resource. -
ResourceName: string
Maximum Length:
256
The unique resource name to identify a resource. -
RestEndPoint: string
Maximum Length:
1000
The REST end point. -
SeedDataLock: integer
(int32)
Default Value:
1
The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified. -
Version: string
Maximum Length:
20
The REST version number.
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.