Jump to

• Request
• Response

Update an entity model object to synchronize

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaSyncEntityModels/{SyncId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• SyncId: integer
  The identifier of the synchronization for the entity model object to synchronize.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorOpaSyncEntityModels-item

Type: object

Show Source

• APPModuleConfig(optional): string
  Maximum Length: 100

  The configuration of the application module that is associated with the entity model object to synchronize.
• APPModuleDefinition(optional): string
  Maximum Length: 200

  The definition of the application module that is associated with the entity model object to synchronize.
• CardinalityWithGlobal(optional): string
  Maximum Length: 5

  Indicates the cardinality of the entity model with the global entity model in the associated metadata model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, and C_MN for many to many relationship.
• ChangeType(optional): string
  Maximum Length: 20

  Indicates the type of change that is required to be synchronized. Valid values are NEW for the new application schema objects that are to be introduced into the Oracle Policy Automation configuration schema, UPDATE for updating the configuration schema objects with the modifications made to the corresponding objects in application schema, and DELETE for deleting the configuration schema objects as the corresponding objects no longer exist in application schema.
• CompletedOn(optional): string(date-time)
  The date on which the synchronization operation was completed.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the entity model object to synchronize.
• CreatedOn(optional): string(date-time)
  The date on which the entity model object to synchronize was created.
• CreationDate(optional): string(date-time)
  The date on which the entity model object to synchronize was created.
• EntityModelName(optional): string
  Maximum Length: 30

  The name of the entity model that is associated with the entity model object to synchronize.
• FullViewObjectName(optional): string
  Maximum Length: 200

  The name of the Full View object that is associated with the entity model object to synchronize.
• IsGlobal(optional): string
  Maximum Length: 1

  Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.
• LastUpdateDate(optional): string(date-time)
  The date on which the entity model object to synchronize was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the entity model object to synchronize.
• links(optional): array Items
  Title: Items

  Link Relations
• MetaDataModelName(optional): string
  Maximum Length: 30

  The name of the metadata model that is associated with the entity model object to synchronize.
• ResourceName(optional): string
  Maximum Length: 100

  The name of the resource that is associated with the entity model object to synchronize.
• SyncId(optional): integer(int64)
  The identifier of the synchronization for the entity model object to synchronize.
• SyncMode(optional): number
  Indicates the mode of the synchronization operation. Valid values are 1 for batch synchronization and 2 for immediate synchronization.
• SyncStatus(optional): string
  Maximum Length: 20

  Indicates the status of the synchronization operation. Valid values are Success, In Progress, On Hold, and Failed.
• SyncStatusNotes(optional): string
  Maximum Length: 500

  The comments from the status of the synchronization operation.
• ViewObjectName(optional): string
  Maximum Length: 100

  The name of the View object that is associated with the entity model object to synchronize.

{
    "properties":{
        "APPModuleConfig":{
            "maxLength":100,
            "type":"string",
            "description":"The configuration of the application module that is associated with the entity model object to synchronize."
        },
        "APPModuleDefinition":{
            "maxLength":200,
            "type":"string",
            "description":"The definition of the application module that is associated with the entity model object to synchronize."
        },
        "CardinalityWithGlobal":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the cardinality of the entity model with the global entity model in the associated metadata model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, and C_MN for many to many relationship."
        },
        "ChangeType":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates the type of change that is required to be synchronized. Valid values are NEW for the new application schema objects that are to be introduced into the Oracle Policy Automation configuration schema, UPDATE for updating the configuration schema objects with the modifications made to the corresponding objects in application schema, and DELETE for deleting the configuration schema objects as the corresponding objects no longer exist in application schema."
        },
        "CompletedOn":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the synchronization operation was completed."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the entity model object to synchronize."
        },
        "CreatedOn":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was created."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was created."
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity model object to synchronize."
        },
        "FullViewObjectName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the Full View object that is associated with the entity model object to synchronize."
        },
        "IsGlobal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity model object to synchronize."
        },
        "MetaDataModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the metadata model that is associated with the entity model object to synchronize."
        },
        "ResourceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the resource that is associated with the entity model object to synchronize."
        },
        "SyncId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the synchronization for the entity model object to synchronize."
        },
        "SyncMode":{
            "type":"number",
            "description":"Indicates the mode of the synchronization operation. Valid values are 1 for batch synchronization and 2 for immediate synchronization."
        },
        "SyncStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates the status of the synchronization operation. Valid values are Success, In Progress, On Hold, and Failed."
        },
        "SyncStatusNotes":{
            "maxLength":500,
            "type":"string",
            "description":"The comments from the status of the synchronization operation."
        },
        "ViewObjectName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the View object that is associated with the entity model object to synchronize."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaSyncEntityModels-item

Type: object

Show Source

• APPModuleConfig(optional): string
  Maximum Length: 100

  The configuration of the application module that is associated with the entity model object to synchronize.
• APPModuleDefinition(optional): string
  Maximum Length: 200

  The definition of the application module that is associated with the entity model object to synchronize.
• CardinalityWithGlobal(optional): string
  Maximum Length: 5

  Indicates the cardinality of the entity model with the global entity model in the associated metadata model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, and C_MN for many to many relationship.
• ChangeType(optional): string
  Maximum Length: 20

  Indicates the type of change that is required to be synchronized. Valid values are NEW for the new application schema objects that are to be introduced into the Oracle Policy Automation configuration schema, UPDATE for updating the configuration schema objects with the modifications made to the corresponding objects in application schema, and DELETE for deleting the configuration schema objects as the corresponding objects no longer exist in application schema.
• CompletedOn(optional): string(date-time)
  The date on which the synchronization operation was completed.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the entity model object to synchronize.
• CreatedOn(optional): string(date-time)
  The date on which the entity model object to synchronize was created.
• CreationDate(optional): string(date-time)
  The date on which the entity model object to synchronize was created.
• EntityModelName(optional): string
  Maximum Length: 30

  The name of the entity model that is associated with the entity model object to synchronize.
• FullViewObjectName(optional): string
  Maximum Length: 200

  The name of the Full View object that is associated with the entity model object to synchronize.
• IsGlobal(optional): string
  Maximum Length: 1

  Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.
• LastUpdateDate(optional): string(date-time)
  The date on which the entity model object to synchronize was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the entity model object to synchronize.
• links(optional): array Items
  Title: Items

  Link Relations
• MetaDataModelName(optional): string
  Maximum Length: 30

  The name of the metadata model that is associated with the entity model object to synchronize.
• ResourceName(optional): string
  Maximum Length: 100

  The name of the resource that is associated with the entity model object to synchronize.
• SyncId(optional): integer(int64)
  The identifier of the synchronization for the entity model object to synchronize.
• SyncMode(optional): number
  Indicates the mode of the synchronization operation. Valid values are 1 for batch synchronization and 2 for immediate synchronization.
• SyncStatus(optional): string
  Maximum Length: 20

  Indicates the status of the synchronization operation. Valid values are Success, In Progress, On Hold, and Failed.
• SyncStatusNotes(optional): string
  Maximum Length: 500

  The comments from the status of the synchronization operation.
• ViewObjectName(optional): string
  Maximum Length: 100

  The name of the View object that is associated with the entity model object to synchronize.

{
    "properties":{
        "APPModuleConfig":{
            "maxLength":100,
            "type":"string",
            "description":"The configuration of the application module that is associated with the entity model object to synchronize."
        },
        "APPModuleDefinition":{
            "maxLength":200,
            "type":"string",
            "description":"The definition of the application module that is associated with the entity model object to synchronize."
        },
        "CardinalityWithGlobal":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the cardinality of the entity model with the global entity model in the associated metadata model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, and C_MN for many to many relationship."
        },
        "ChangeType":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates the type of change that is required to be synchronized. Valid values are NEW for the new application schema objects that are to be introduced into the Oracle Policy Automation configuration schema, UPDATE for updating the configuration schema objects with the modifications made to the corresponding objects in application schema, and DELETE for deleting the configuration schema objects as the corresponding objects no longer exist in application schema."
        },
        "CompletedOn":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the synchronization operation was completed."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the entity model object to synchronize."
        },
        "CreatedOn":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was created."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was created."
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity model object to synchronize."
        },
        "FullViewObjectName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the Full View object that is associated with the entity model object to synchronize."
        },
        "IsGlobal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity model object to synchronize was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity model object to synchronize."
        },
        "MetaDataModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the metadata model that is associated with the entity model object to synchronize."
        },
        "ResourceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the resource that is associated with the entity model object to synchronize."
        },
        "SyncId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the synchronization for the entity model object to synchronize."
        },
        "SyncMode":{
            "type":"number",
            "description":"Indicates the mode of the synchronization operation. Valid values are 1 for batch synchronization and 2 for immediate synchronization."
        },
        "SyncStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates the status of the synchronization operation. Valid values are Success, In Progress, On Hold, and Failed."
        },
        "SyncStatusNotes":{
            "maxLength":500,
            "type":"string",
            "description":"The comments from the status of the synchronization operation."
        },
        "ViewObjectName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the View object that is associated with the entity model object to synchronize."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top