Jump to

• Request
• Response

Update a subclass

patch

/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas/{SubclassId}

Request

Path Parameters

• SubclassId(required): string
  The unique identifier for a subclass, which is generated during a create action.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdfmCatalog: string
  Maximum Length: 200

  The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml.
• AppmodConfig: string
  Maximum Length: 100

  The application module definition. For example, ApplicationIntakeAMLocal.
• AppmodName: string
  Maximum Length: 100

  The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM.
• BaseEoName: string
  Maximum Length: 200

  The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO.
• BasePackageName: string
  Maximum Length: 200

  The base package name. For example, oracle.apps.psc.permits.applicationIntake.model.
• BaseVoName: string
  Maximum Length: 200

  The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.
• CustomApplyDataRole: string
  Maximum Length: 100

  The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA.
• CustomManageAgencyRole: string
  Maximum Length: 100

  The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY.
• CustomManageRole: string
  Maximum Length: 100

  The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE.
• CustomPscViewAllAppl: string
  Maximum Length: 100

  The custom role for viewing workflow process definitions.
• CustomViewRole: string
  Maximum Length: 100

  The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE.
• DiscrCodeProperty: string
  Maximum Length: 60

  The value of the discriminator. For example, RecordTypeId.
• DiscrColumnName: string
  Maximum Length: 60

  The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID.
• DiscrPropertyName: string
  Maximum Length: 60

  The property name of the discriminator. For example, RecordTypeId.
• NewEoSuffix: string
  Maximum Length: 60

  The new suffix for the entity object. For example, RecordEO.
• NewFlatvoSuffix: string
  Maximum Length: 60

  The suffix for the flattened view object. For example, RecordFlatVO.
• NewRestflatSuffix: string
  Maximum Length: 60

  The new REST suffix for the flattened view object. For example, RecordFlatVO.
• NewRestSuffix: string
  Maximum Length: 60

  The new REST suffix. For example, RecordVO.
• NewVoSuffix: string
  Maximum Length: 60

  The new suffix for the view object. For example, RecordVO.
• OpssAdministratorPrivileges: string
  Maximum Length: 200

  The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update.
• OpssAdministratorUser: string
  Maximum Length: 20

  The user ID of the OPSS administrator user. For example, Admin.
• OpssPolicyName: string
  Maximum Length: 60

  The OPSS policy name associated with the subclass.
• OpssRestPermission: string
  Maximum Length: 200

  The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission.
• ResourceRegistry: string
  Maximum Length: 200

  The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx.
• RestSubpackage: string
  Maximum Length: 60

  The REST subpackage of the subclass. For example, resources.
• SessiondefPackageName: string
  Maximum Length: 200

  The session definition package name. For example, sessiondef.civic.model.
• SourcePropertyName: string
  Maximum Length: 60

  The name of the source property. For example, SourceAlias.
• SubclassDescription: string
  Maximum Length: 100

  The description of a subclass.
• TableKey: string
  Maximum Length: 100

  The key for the underlying table.
• TableName: string
  Maximum Length: 60

  The table name of a subclass. For example, PSC_LNP_RECORD.
• VoKey: string
  Maximum Length: 100

  The key for the underlying view object.

{
    "type":"object",
    "properties":{
        "RestSubpackage":{
            "maxLength":"60",
            "type":"string",
            "description":"The REST subpackage of the subclass. For example, resources.",
            "nullable":false
        },
        "NewEoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new suffix for the entity object. For example, RecordEO.",
            "nullable":false
        },
        "SessiondefPackageName":{
            "maxLength":"200",
            "type":"string",
            "description":"The session definition package name. For example, sessiondef.civic.model.",
            "nullable":false
        },
        "OpssPolicyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The OPSS policy name associated with the subclass.",
            "nullable":false
        },
        "DiscrColumnName":{
            "maxLength":"60",
            "type":"string",
            "description":"The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID.",
            "nullable":false
        },
        "NewFlatvoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The suffix for the flattened view object. For example, RecordFlatVO.",
            "nullable":false
        },
        "OpssRestPermission":{
            "maxLength":"200",
            "type":"string",
            "description":"The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission.",
            "nullable":false
        },
        "SourcePropertyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the source property. For example, SourceAlias.",
            "nullable":false
        },
        "AdfmCatalog":{
            "maxLength":"200",
            "type":"string",
            "description":"The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml.",
            "nullable":false
        },
        "CustomViewRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE.",
            "nullable":true
        },
        "OpssAdministratorPrivileges":{
            "maxLength":"200",
            "type":"string",
            "description":"The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update.",
            "nullable":false
        },
        "NewRestflatSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new REST suffix for the flattened view object. For example, RecordFlatVO.",
            "nullable":false
        },
        "DiscrPropertyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The property name of the discriminator. For example, RecordTypeId.",
            "nullable":false
        },
        "AppmodConfig":{
            "maxLength":"100",
            "type":"string",
            "description":"The application module definition. For example, ApplicationIntakeAMLocal.",
            "nullable":false
        },
        "BasePackageName":{
            "maxLength":"200",
            "type":"string",
            "description":"The base package name. For example, oracle.apps.psc.permits.applicationIntake.model.",
            "nullable":false
        },
        "CustomApplyDataRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA.",
            "nullable":true
        },
        "VoKey":{
            "maxLength":"100",
            "type":"string",
            "description":"The key for the underlying view object.",
            "nullable":true
        },
        "TableKey":{
            "maxLength":"100",
            "type":"string",
            "description":"The key for the underlying table.",
            "nullable":true
        },
        "ResourceRegistry":{
            "maxLength":"200",
            "type":"string",
            "description":"The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx.",
            "nullable":false
        },
        "CustomPscViewAllAppl":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom role for viewing workflow process definitions.",
            "nullable":true
        },
        "BaseVoName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.",
            "nullable":false
        },
        "CustomManageAgencyRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY.",
            "nullable":true
        },
        "OpssAdministratorUser":{
            "maxLength":"20",
            "type":"string",
            "description":"The user ID of the OPSS administrator user. For example, Admin.",
            "nullable":true
        },
        "TableName":{
            "maxLength":"60",
            "type":"string",
            "description":"The table name of a subclass. For example, PSC_LNP_RECORD.",
            "nullable":false
        },
        "NewRestSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new REST suffix. For example, RecordVO.",
            "nullable":false
        },
        "CustomManageRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE.",
            "nullable":true
        },
        "SubclassDescription":{
            "maxLength":"100",
            "type":"string",
            "description":"The description of a subclass.",
            "nullable":false
        },
        "NewVoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new suffix for the view object. For example, RecordVO.",
            "nullable":false
        },
        "AppmodName":{
            "maxLength":"100",
            "type":"string",
            "description":"The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM.",
            "nullable":false
        },
        "DiscrCodeProperty":{
            "maxLength":"60",
            "type":"string",
            "description":"The value of the discriminator. For example, RecordTypeId.",
            "nullable":false
        },
        "BaseEoName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AdfmCatalog: string
  Maximum Length: 200

  The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml.
• AppmodConfig: string
  Maximum Length: 100

  The application module definition. For example, ApplicationIntakeAMLocal.
• AppmodName: string
  Maximum Length: 100

  The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM.
• BaseEoName: string
  Maximum Length: 200

  The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO.
• BasePackageName: string
  Maximum Length: 200

  The base package name. For example, oracle.apps.psc.permits.applicationIntake.model.
• BaseVoName: string
  Maximum Length: 200

  The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.
• CustomApplyDataRole: string
  Maximum Length: 100

  The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA.
• CustomManageAgencyRole: string
  Maximum Length: 100

  The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY.
• CustomManageRole: string
  Maximum Length: 100

  The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE.
• CustomPscViewAllAppl: string
  Maximum Length: 100

  The custom role for viewing workflow process definitions.
• CustomViewRole: string
  Maximum Length: 100

  The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE.
• DiscrCodeProperty: string
  Maximum Length: 60

  The value of the discriminator. For example, RecordTypeId.
• DiscrColumnName: string
  Maximum Length: 60

  The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID.
• DiscrPropertyName: string
  Maximum Length: 60

  The property name of the discriminator. For example, RecordTypeId.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewEoSuffix: string
  Maximum Length: 60

  The new suffix for the entity object. For example, RecordEO.
• NewFlatvoSuffix: string
  Maximum Length: 60

  The suffix for the flattened view object. For example, RecordFlatVO.
• NewRestflatSuffix: string
  Maximum Length: 60

  The new REST suffix for the flattened view object. For example, RecordFlatVO.
• NewRestSuffix: string
  Maximum Length: 60

  The new REST suffix. For example, RecordVO.
• NewVoSuffix: string
  Maximum Length: 60

  The new suffix for the view object. For example, RecordVO.
• OpssAdministratorPrivileges: string
  Maximum Length: 200

  The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update.
• OpssAdministratorUser: string
  Maximum Length: 20

  The user ID of the OPSS administrator user. For example, Admin.
• OpssPolicyName: string
  Maximum Length: 60

  The OPSS policy name associated with the subclass.
• OpssRestPermission: string
  Maximum Length: 200

  The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission.
• ResourceRegistry: string
  Maximum Length: 200

  The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx.
• RestSubpackage: string
  Maximum Length: 60

  The REST subpackage of the subclass. For example, resources.
• SessiondefPackageName: string
  Maximum Length: 200

  The session definition package name. For example, sessiondef.civic.model.
• SourcePropertyName: string
  Maximum Length: 60

  The name of the source property. For example, SourceAlias.
• SubclassDescription: string
  Maximum Length: 100

  The description of a subclass.
• SubclassId: string
  Maximum Length: 50

  The unique identifier for a subclass, which is generated during a create action.
• TableKey: string
  Maximum Length: 100

  The key for the underlying table.
• TableName: string
  Maximum Length: 60

  The table name of a subclass. For example, PSC_LNP_RECORD.
• VoKey: string
  Maximum Length: 100

  The key for the underlying view object.

{
    "type":"object",
    "properties":{
        "RestSubpackage":{
            "maxLength":"60",
            "type":"string",
            "description":"The REST subpackage of the subclass. For example, resources.",
            "nullable":false,
            "x-queryable":true
        },
        "NewEoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new suffix for the entity object. For example, RecordEO.",
            "nullable":false,
            "x-queryable":true
        },
        "SessiondefPackageName":{
            "maxLength":"200",
            "type":"string",
            "description":"The session definition package name. For example, sessiondef.civic.model.",
            "nullable":false,
            "x-queryable":true
        },
        "OpssPolicyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The OPSS policy name associated with the subclass.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscrColumnName":{
            "maxLength":"60",
            "type":"string",
            "description":"The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID.",
            "nullable":false,
            "x-queryable":true
        },
        "NewFlatvoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The suffix for the flattened view object. For example, RecordFlatVO.",
            "nullable":false,
            "x-queryable":true
        },
        "OpssRestPermission":{
            "maxLength":"200",
            "type":"string",
            "description":"The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission.",
            "nullable":false,
            "x-queryable":true
        },
        "SourcePropertyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the source property. For example, SourceAlias.",
            "nullable":false,
            "x-queryable":true
        },
        "AdfmCatalog":{
            "maxLength":"200",
            "type":"string",
            "description":"The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomViewRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE.",
            "nullable":true,
            "x-queryable":true
        },
        "OpssAdministratorPrivileges":{
            "maxLength":"200",
            "type":"string",
            "description":"The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewRestflatSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new REST suffix for the flattened view object. For example, RecordFlatVO.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscrPropertyName":{
            "maxLength":"60",
            "type":"string",
            "description":"The property name of the discriminator. For example, RecordTypeId.",
            "nullable":false,
            "x-queryable":true
        },
        "AppmodConfig":{
            "maxLength":"100",
            "type":"string",
            "description":"The application module definition. For example, ApplicationIntakeAMLocal.",
            "nullable":false,
            "x-queryable":true
        },
        "BasePackageName":{
            "maxLength":"200",
            "type":"string",
            "description":"The base package name. For example, oracle.apps.psc.permits.applicationIntake.model.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomApplyDataRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA.",
            "nullable":true,
            "x-queryable":true
        },
        "VoKey":{
            "maxLength":"100",
            "type":"string",
            "description":"The key for the underlying view object.",
            "nullable":true,
            "x-queryable":true
        },
        "TableKey":{
            "maxLength":"100",
            "type":"string",
            "description":"The key for the underlying table.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceRegistry":{
            "maxLength":"200",
            "type":"string",
            "description":"The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomPscViewAllAppl":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom role for viewing workflow process definitions.",
            "nullable":true,
            "x-queryable":true
        },
        "BaseVoName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomManageAgencyRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY.",
            "nullable":true,
            "x-queryable":true
        },
        "OpssAdministratorUser":{
            "maxLength":"20",
            "type":"string",
            "description":"The user ID of the OPSS administrator user. For example, Admin.",
            "nullable":true,
            "x-queryable":true
        },
        "TableName":{
            "maxLength":"60",
            "type":"string",
            "description":"The table name of a subclass. For example, PSC_LNP_RECORD.",
            "nullable":false,
            "x-queryable":true
        },
        "NewRestSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new REST suffix. For example, RecordVO.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomManageRole":{
            "maxLength":"100",
            "type":"string",
            "description":"The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE.",
            "nullable":true,
            "x-queryable":true
        },
        "SubclassDescription":{
            "maxLength":"100",
            "type":"string",
            "description":"The description of a subclass.",
            "nullable":false,
            "x-queryable":true
        },
        "SubclassId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for a subclass, which is generated during a create action.",
            "nullable":false,
            "x-queryable":true
        },
        "NewVoSuffix":{
            "maxLength":"60",
            "type":"string",
            "description":"The new suffix for the view object. For example, RecordVO.",
            "nullable":false,
            "x-queryable":true
        },
        "AppmodName":{
            "maxLength":"100",
            "type":"string",
            "description":"The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscrCodeProperty":{
            "maxLength":"60",
            "type":"string",
            "description":"The value of the discriminator. For example, RecordTypeId.",
            "nullable":false,
            "x-queryable":true
        },
        "BaseEoName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO.",
            "nullable":false,
            "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