Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "NumberType":{
            "title":"Number Type",
            "maxLength":"10",
            "type":"string",
            "description":"A code for the transaction or object that uses the autonumber rule. Examples include codes for invoices, permits, and inspections.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the autonumber rule.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a autonumber rule.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "RuleId":{
            "title":"Rule Name",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier for an autonumber rule.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            }
        },
        "MaxLength":{
            "title":"Maximum Size",
            "type":"integer",
            "description":"The maximum length of the number that is generated by an autonumber rule.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "AutoNumberRule":{
            "maxLength":"1000",
            "type":"string",
            "description":"The autonumber rule stored in JSON format.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorAutoNumbers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the autonumber rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the autonumber rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the autonumber rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the autonumber rule.",
            "nullable":false,
            "x-queryable":true
        },
        "NextNumberPreview":{
            "title":"Next Number",
            "maxLength":"255",
            "type":"string",
            "description":"The next number to be generated by an autonumber rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a autonumber rule.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule Name",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier for an autonumber rule.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "NumberTypeDescr":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"A description of the transaction or object that uses the autonumber rule. Examples include Invoice, Permit, and Inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaxLength":{
            "title":"Maximum Size",
            "type":"integer",
            "description":"The maximum length of the number that is generated by an autonumber rule.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "NumberType":{
            "title":"Number Type",
            "maxLength":"10",
            "type":"string",
            "description":"A code for the transaction or object that uses the autonumber rule. Examples include codes for invoices, permits, and inspections.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the autonumber rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleDetails":{
            "type":"string",
            "description":"Transient field that returns autonumber details in JSON format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoNumberRule":{
            "maxLength":"1000",
            "type":"string",
            "description":"The autonumber rule stored in JSON format.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

getNextNumber

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAutoNumbers/{RuleId}/action/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.

Back to Top