Create a custom callback
post
/fscmRestApi/resources/11.13.18.05/publicSectorCustomCallbacks
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccessType: string
Maximum Length:
255
Default Value:None
The type of access to be given. For example: NONE, CONFIDENTIAL, HIDE_FROM_PUBLIC, or READ_ONLY. -
BaseVoKey: string
The key field of the base view object.
-
BaseVoName: string
The name of the view object from which the new record type is derived.
-
ChildObject: string
Default Value:
N
Indicates if the record is a child record. -
CustomApplyDataRole: string
The role name needed to access the data in the records (the data security role for public users).
-
CustomManageAgencyRole: string
The role name needed to manage the data in the records (the data security role for agency staff users).
-
CustomManageRole: string
The role name needed to manipulate records, such as permits, incidents, cases, and so on.
-
CustomPscViewAllAppl: string
The role needed to view all types of applications.
-
CustomViewRole: string
The role name needed to view records, such as permits, incidents, cases, and so on.
-
IsNewGrid: string
Default Value:
N
Indicates if the record is a new grid object. -
RecordType: string
The name of the record type, which is a blend of the product name and the record type code. A record type can be a permit, an incident, a case, and so on.
-
ReCreate: string
Default Value:
N
Indicates if the record artifacts need to be recreated. -
SubClassId: string
Maximum Length:
255
The unique Identifier for a record. -
TableKey: string
The key field of the table used for the base record type.
-
TableName: string
The name of the table on which the new record type is based.
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 : publicSectorCustomCallbacks-item-response
Type:
Show Source
object
-
AccessType: string
Maximum Length:
255
Default Value:None
The type of access to be given. For example: NONE, CONFIDENTIAL, HIDE_FROM_PUBLIC, or READ_ONLY. -
BaseVoKey: string
The key field of the base view object.
-
BaseVoName: string
The name of the view object from which the new record type is derived.
-
ChildObject: string
Default Value:
N
Indicates if the record is a child record. -
CustomApplyDataRole: string
The role name needed to access the data in the records (the data security role for public users).
-
CustomManageAgencyRole: string
The role name needed to manage the data in the records (the data security role for agency staff users).
-
CustomManageRole: string
The role name needed to manipulate records, such as permits, incidents, cases, and so on.
-
CustomPscViewAllAppl: string
The role needed to view all types of applications.
-
CustomViewRole: string
The role name needed to view records, such as permits, incidents, cases, and so on.
-
IsNewGrid: string
Default Value:
N
Indicates if the record is a new grid object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordType: string
The name of the record type, which is a blend of the product name and the record type code. A record type can be a permit, an incident, a case, and so on.
-
ReCreate: string
Default Value:
N
Indicates if the record artifacts need to be recreated. -
SubClassId: string
Maximum Length:
255
The unique Identifier for a record. -
TableKey: string
The key field of the table used for the base record type.
-
TableName: string
The name of the table on which the new record type is based.
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.