Create an autonumber rule
post
/fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers
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
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for an agency that is associated with a autonumber rule. -
AutoNumberRule: string
Maximum Length:
1000
The autonumber rule stored in JSON format. -
Description: string
Title:
Description
Maximum Length:50
The description of the autonumber rule. -
MaxLength: integer
(int32)
Title:
Maximum Size
The maximum length of the number that is generated by an autonumber rule. -
NumberType: string
Title:
Number Type
Maximum Length:10
A code for the transaction or object that uses the autonumber rule. Examples include codes for invoices, permits, and inspections. -
RuleId: string
Title:
Rule Name
Maximum Length:20
The unique identifier for an autonumber rule.
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 : publicSectorAutoNumbers-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for an agency that is associated with a autonumber rule. -
AutoNumberRule: string
Maximum Length:
1000
The autonumber rule stored in JSON format. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the autonumber rule. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the autonumber rule was created. -
Description: string
Title:
Description
Maximum Length:50
The description of the autonumber rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the autonumber rule was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the autonumber rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxLength: integer
(int32)
Title:
Maximum Size
The maximum length of the number that is generated by an autonumber rule. -
NextNumberPreview: string
Title:
Next Number
Read Only:true
Maximum Length:255
The next number to be generated by an autonumber rule. -
NumberType: string
Title:
Number Type
Maximum Length:10
A code for the transaction or object that uses the autonumber rule. Examples include codes for invoices, permits, and inspections. -
NumberTypeDescr: string
Title:
Meaning
Read Only:true
Maximum Length:80
A description of the transaction or object that uses the autonumber rule. Examples include Invoice, Permit, and Inspection. -
RuleDetails: string
Read Only:
true
Transient field that returns autonumber details in JSON format. -
RuleId: string
Title:
Rule Name
Maximum Length:20
The unique identifier for an autonumber rule.
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.
Links
- getNextNumber
-
Parameters:
- RuleId:
$request.path.RuleId
Get the next number or numbers based on the given autonumber rule ID and on how many numbers should be returned in one call. - RuleId: