Create a set of status mappings for a contractor validation option is not allowed
post
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings
Request
Path Parameters
-
publicSectorRegContractorOptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LicenseSetupCode and AgencyId ---for the Contractor Options for Registered Users resource and used to uniquely identify an instance of Contractor Options for Registered Users. The client should not generate the hash key value. Instead, the client should query on the Contractor Options for Registered Users collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Options for Registered Users.
For example: publicSectorRegContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>
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
(int32)
Identifier for the agency that is maintaining contractor license information.
-
DeclineApplication: string
Title:
Decline Application
Maximum Length:1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus: string
Title:
Status
Maximum Length:30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
SourceStatus: string
Title:
Source Status
Maximum Length:100
Contractor license status that is assigned by a third party licensing body.
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 : publicSectorRegContractorOptions-ContractorOptionStatusMappings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
DeclineApplication: string
Title:
Decline Application
Maximum Length:1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus: string
Title:
Status
Maximum Length:30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceStatus: string
Title:
Source Status
Maximum Length:100
Contractor license status that is assigned by a third party licensing body.
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.