Update a snapshot setting instance
patch
/fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}
Request
Path Parameters
-
SnapshotSetupId(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=
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
-
applicationStatuses: array
Application Snapshot Settings Statuses
Title:
Application Snapshot Settings Statuses
The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken. -
assignments: array
Application Snapshot Settings Assignments
Title:
Application Snapshot Settings Assignments
The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance. -
SnapshotSetupDescription: string
Title:
Description
Maximum Length:240
Description of the snapshot setting. -
SnapshotSetupName: string
Title:
Name
Maximum Length:100
Name of the snapshot setting.
Nested Schema : Application Snapshot Settings Statuses
Type:
array
Title:
Application Snapshot Settings Statuses
The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.
Show Source
Nested Schema : Application Snapshot Settings Assignments
Type:
array
Title:
Application Snapshot Settings Assignments
The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ApplicationStatusCode: string
Title:
Application Status Code
Maximum Length:30
The application status code associated with the snapshot setting.
Nested Schema : schema
Type:
Show Source
object
-
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
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 : applicationSnapshotSettings-item-response
Type:
Show Source
object
-
applicationStatuses: array
Application Snapshot Settings Statuses
Title:
Application Snapshot Settings Statuses
The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken. -
assignments: array
Application Snapshot Settings Assignments
Title:
Application Snapshot Settings Assignments
The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SnapshotSetupCode: string
Title:
Snapshot Setup Code
Maximum Length:50
The alternate unique identifier for a snapshot setting. -
SnapshotSetupDescription: string
Title:
Description
Maximum Length:240
Description of the snapshot setting. -
SnapshotSetupId: integer
(int64)
Title:
Snapshot Setup ID
Read Only:true
The unique identifier for a snapshot setting. -
SnapshotSetupName: string
Title:
Name
Maximum Length:100
Name of the snapshot setting.
Nested Schema : Application Snapshot Settings Statuses
Type:
array
Title:
Application Snapshot Settings Statuses
The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.
Show Source
Nested Schema : Application Snapshot Settings Assignments
Type:
array
Title:
Application Snapshot Settings Assignments
The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : applicationSnapshotSettings-applicationStatuses-item-response
Type:
Show Source
object
-
ApplicationStatusCode: string
Title:
Application Status Code
Maximum Length:30
The application status code associated with the snapshot setting. -
ApplicationStatusMeaning: string
Title:
Application Status
Read Only:true
Maximum Length:80
Meaning of the application status code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SnapshotStatusId: integer
(int64)
Title:
Snapshot Status ID
Read Only:true
The unique identifier for a snapshot settings application status.
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.
Nested Schema : applicationSnapshotSettings-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the associated entity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- applicationStatuses
-
Parameters:
- SnapshotSetupId:
$request.path.SnapshotSetupId
The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken. - SnapshotSetupId:
- assignments
-
Operation: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignmentsParameters:
- SnapshotSetupId:
$request.path.SnapshotSetupId
The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance. - SnapshotSetupId: