Create a set of fee schedule maps
post
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD
Request
Path Parameters
-
FeeLineUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate, EffectiveEndDate and FeeScheduleLine ---for the Fee Lines resource and used to uniquely identify an instance of Fee Lines. The client should not generate the hash key value. Instead, the client should query on the Fee Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Lines.
For example: FeeLine?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;FeeScheduleLine=<value5> -
publicSectorFeeSchedulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate and EffectiveEndDate ---for the Fee Schedules resource and used to uniquely identify an instance of Fee Schedules. The client should not generate the hash key value. Instead, the client should query on the Fee Schedules collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Schedules.
For example: publicSectorFeeSchedules?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
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
-
AgencyId: integer
The identifier for the public sector agency to which this fee schedule map belongs.
-
EffectiveEndDate: string
(date)
The end date of the fee schedule map.
-
EffectiveStartDate: string
(date)
The start date of the fee schedule map.
-
FeeScheduleId: string
Maximum Length:
20
A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
-
FieldNum: integer
The sequence number for the field in the mapping table.
-
MappingType: string
Maximum Length:
10
The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50
The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30
The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200
The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200
The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50
This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200
The label for the target field name. -
TargetObjectname: string
Maximum Length:
200
The name of the target business object for an array.
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 : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response
Type:
Show Source
object
-
AgencyId: integer
The identifier for the public sector agency to which this fee schedule map belongs.
-
CreationDate: string
(date-time)
Read Only:
true
The date when the fee schedule map was created. -
EffectiveEndDate: string
(date)
The end date of the fee schedule map.
-
EffectiveStartDate: string
(date)
The start date of the fee schedule map.
-
FeeScheduleId: string
Maximum Length:
20
A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
-
FieldNum: integer
The sequence number for the field in the mapping table.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the fee schedule map was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingType: string
Maximum Length:
10
The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50
The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30
The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200
The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200
The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50
This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200
The label for the target field name. -
TargetObjectname: string
Maximum Length:
200
The name of the target business object for an array.
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.