Get a user setup
get
/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}
Request
Path Parameters
-
UserSetupId: string
Identifies the row in the public user setup table. The only valid value is PSC.
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).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorUserSetups-item
Type:
Show Source
object
-
AllowAttachments(optional):
string
Maximum Length:
1
Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N. -
AllowDeleteAttachments(optional):
string
Maximum Length:
1
Indicates whether registered public users can delete documents in account management. -
CntrctrFlagVerificationOn(optional):
string
Maximum Length:
1
Indicates whether the agency needs to verify a registered user's claim to be a contractor. If the value is Y, the agency needs to verify the claim. The default value is N. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the row. -
CreationDate(optional):
string(date-time)
The date and time of the creation of the row.
-
DeletedFlag(optional):
boolean
Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N.
-
LastUpdateDate(optional):
string(date-time)
The date and time of the last update of the row.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the row. -
LicenseVerificationOn(optional):
string
Maximum Length:
1
Indicates whether the agency needs to verify licenses entered by a user. If the value is Y, the agency needs to verify the license. The default value is N. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
PaymentAcctVerificationOn(optional):
string
Maximum Length:
1
Indicates whether the agency needs to verify payment accounts entered by a user. If the value is Y, the agency needs to verify payment accounts. The default value is N. -
SeedDataLock(optional):
integer(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
-
SensitiveFlagOn(optional):
string
Maximum Length:
1
Indicates whether to ask users if they are members of law enforcement or a judiciary agency. Data for such users may require special handling. If the value is Y, users are asked if they are members of these groups. The default value is N. -
SensitiveFlagVerificationOn(optional):
string
Maximum Length:
1
Indicates whether the agency needs to verify a registered user's claim to be a member of law enforcement or a judiciary agency. If the value is Y, the user's claim needs to be verified. The default value is N. -
TermsOfUseOn(optional):
string
Maximum Length:
1
Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N. -
UserCategory(optional):
string
Maximum Length:
240
Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password. -
UserPrvsngVerificationOn(optional):
string
Maximum Length:
1
Indicates whether the agency needs to verify a user's registration before the user is provisioned. If the value is Y, the registration needs to be verified. The default value is N. -
UserSetupId(optional):
string
Maximum Length:
3
Identifies the row in the public user setup table. The only valid value is PSC. -
UserTermsOfUseId(optional):
string
Title:
Terms of Use ID
Maximum Length:15
Identifier for the terms of use, if any, that the user needs to accept during registration.
Nested Schema : link
Type:
Show Source
object
-
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.