Jump to

• Request
• Response

Get a subclass

get

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

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• AdfmCatalog(optional): 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(optional): string
  Maximum Length: 100

  The application module definition. For example, ApplicationIntakeAMLocal.
• AppmodName(optional): 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(optional): string
  Maximum Length: 200

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

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

  The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the subclass.
• CreationDate(optional): string(date-time)
  The date and time the subclass was created.
• CustomApplyDataRole(optional): string
  Maximum Length: 100

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

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

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

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

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

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

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

  The property name of the discriminator. For example, RecordTypeId.
• LastUpdateDate(optional): string(date-time)
  The date and time a subclass was last modified.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the subclass definition.
• links(optional): array Items
  Title: Items

  Link Relations
• NewEoSuffix(optional): string
  Maximum Length: 60

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  The key for the underlying view object.

{
    "properties":{
        "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."
        },
        "AppmodConfig":{
            "maxLength":100,
            "type":"string",
            "description":"The application module definition. For example, ApplicationIntakeAMLocal."
        },
        "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."
        },
        "BaseEoName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO."
        },
        "BasePackageName":{
            "maxLength":200,
            "type":"string",
            "description":"The base package name. For example, oracle.apps.psc.permits.applicationIntake.model."
        },
        "BaseVoName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subclass."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the subclass was created."
        },
        "CustomApplyDataRole":{
            "maxLength":100,
            "type":"string",
            "description":"The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA."
        },
        "CustomManageAgencyRole":{
            "maxLength":100,
            "type":"string",
            "description":"The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY."
        },
        "CustomManageRole":{
            "maxLength":100,
            "type":"string",
            "description":"The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE."
        },
        "CustomPscViewAllAppl":{
            "maxLength":100,
            "type":"string",
            "description":"The custom role for viewing workflow process definitions."
        },
        "CustomViewRole":{
            "maxLength":100,
            "type":"string",
            "description":"The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE."
        },
        "DiscrCodeProperty":{
            "maxLength":60,
            "type":"string",
            "description":"The value of the discriminator. For example, RecordTypeId."
        },
        "DiscrColumnName":{
            "maxLength":60,
            "type":"string",
            "description":"The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID."
        },
        "DiscrPropertyName":{
            "maxLength":60,
            "type":"string",
            "description":"The property name of the discriminator. For example, RecordTypeId."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time a subclass was last modified."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subclass definition."
        },
        "NewEoSuffix":{
            "maxLength":60,
            "type":"string",
            "description":"The new suffix for the entity object. For example, RecordEO."
        },
        "NewFlatvoSuffix":{
            "maxLength":60,
            "type":"string",
            "description":"The suffix for the flattened view object. For example, RecordFlatVO."
        },
        "NewRestSuffix":{
            "maxLength":60,
            "type":"string",
            "description":"The new REST suffix. For example, RecordVO."
        },
        "NewRestflatSuffix":{
            "maxLength":60,
            "type":"string",
            "description":"The new REST suffix for the flattened view object. For example, RecordFlatVO."
        },
        "NewVoSuffix":{
            "maxLength":60,
            "type":"string",
            "description":"The new suffix for the view object. For example, RecordVO."
        },
        "OpssAdministratorPrivileges":{
            "maxLength":200,
            "type":"string",
            "description":"The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update."
        },
        "OpssAdministratorUser":{
            "maxLength":20,
            "type":"string",
            "description":"The user ID of the OPSS administrator user. For example, Admin."
        },
        "OpssPolicyName":{
            "maxLength":60,
            "type":"string",
            "description":"The OPSS policy name associated with the subclass."
        },
        "OpssRestPermission":{
            "maxLength":200,
            "type":"string",
            "description":"The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission."
        },
        "ResourceRegistry":{
            "maxLength":200,
            "type":"string",
            "description":"The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx."
        },
        "RestSubpackage":{
            "maxLength":60,
            "type":"string",
            "description":"The REST subpackage of the subclass. For example, resources."
        },
        "SessiondefPackageName":{
            "maxLength":200,
            "type":"string",
            "description":"The session definition package name. For example, sessiondef.civic.model."
        },
        "SourcePropertyName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the source property. For example, SourceAlias."
        },
        "SubclassDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of a subclass."
        },
        "SubclassId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a subclass, which is generated during a create action."
        },
        "TableKey":{
            "maxLength":100,
            "type":"string",
            "description":"The key for the underlying table."
        },
        "TableName":{
            "maxLength":60,
            "type":"string",
            "description":"The table name of a subclass. For example, PSC_LNP_RECORD."
        },
        "VoKey":{
            "maxLength":100,
            "type":"string",
            "description":"The key for the underlying view object."
        },
        "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