Create one parameter
post
/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/inboundTrackingRules/{TrackingRuleName}/child/parameters
Request
Path Parameters
-
CarrierId(required): integer(int64)
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
-
TrackingRuleName(required): string
The name of the tracking rule. This attribute is required.
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
-
ConstantValue: string
Title:
Constant Value
Maximum Length:50
The value of the tracking rule parameter when the parameter has a constant value. -
LookupParameterCode: string
Title:
Lookup Parameter
Maximum Length:30
The attribute in the transaction that the URL (Uniform Resource Locator) requires when the parameter value is supplied by the transaction. For example, Tracking number. A list of accepted values is defined in the lookup type WSH_TRACKING_PARAMS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
ParameterName: string
Title:
Parameter Name
Maximum Length:30
The name of the tracking rule parameter. Each parameter may have either a constant value or a value supplied from the transaction. -
Sequence: integer
(int64)
Title:
Sequence
The value that uniquely identifies the order of precedence for each parameter for the tracking rule for a carrier. This attribute is required.
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 : carriers-inboundTrackingRules-parameters-item-response
Type:
Show Source
object
-
ConstantValue: string
Title:
Constant Value
Maximum Length:50
The value of the tracking rule parameter when the parameter has a constant value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupParameter: string
Read Only:
true
Maximum Length:80
The name of the attribute in the transaction that the URL (Uniform Resource Locator) requires when the parameter value is supplied by the transaction. For example, Tracking number. A list of accepted values is defined in the lookup type WSH_TRACKING_PARAMS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
LookupParameterCode: string
Title:
Lookup Parameter
Maximum Length:30
The attribute in the transaction that the URL (Uniform Resource Locator) requires when the parameter value is supplied by the transaction. For example, Tracking number. A list of accepted values is defined in the lookup type WSH_TRACKING_PARAMS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
ParameterId: integer
(int64)
Read Only:
true
The value that uniquely identifies the parameter for the tracking rule for a carrier. It is a value that the application generates when it creates a tracking rule. -
ParameterName: string
Title:
Parameter Name
Maximum Length:30
The name of the tracking rule parameter. Each parameter may have either a constant value or a value supplied from the transaction. -
Sequence: integer
(int64)
Title:
Sequence
The value that uniquely identifies the order of precedence for each parameter for the tracking rule for a carrier. This attribute is required.
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.