Jump to

• Request
• Response

Create a GIS transaction mapping

post

/fscmRestApi/resources/11.13.18.05/publicSectorGISTransactionSyncSetups

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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(required): integer (int32)
  The agency identifier for the GIS transaction mapping.
• Description(required): string
  Title: Description

  Maximum Length: 400

  The description of the mapping identifier of the GIS transaction mapping.
• EnabledFlag(required): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the GIS transaction mapping is enabled.
• GisServiceId(required): string
  Title: Feature Service

  Maximum Length: 30

  The service identifier of the GIS transaction mapping.
• GISSyncMapAttr: array GIS transaction mapping attributes
  Title: GIS transaction mapping attributes

  This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.
• LayerId(required): string
  Maximum Length: 20

  The layer identifier of the GIS transaction mapping.
• LayerName(required): string
  Title: Layer

  Maximum Length: 64

  The layer name of the GIS transaction mapping.
• MappingId(required): string
  Title: Mapping Name

  Maximum Length: 30

  The mapping identifier of the GIS transaction mapping.
• OfferingId(required): string
  Title: Offering

  Maximum Length: 50

  The offering Id of the GIS transaction mapping (e.g. ORA_PSC_OFR_PERMITS, ORA_PSCR_OFR_BUSINESS_LICENSES, ORA_PSCR_OFR_PLANNING_ZONING, ORA_PSCR_OFR_CODE_ENFORCEMENT, ORA_PSC_COMMON).
• RecordTypeId: string
  Maximum Length: 30

  The record type identifier of the GIS transaction mapping.
• ResourceId(required): integer (int64)
  The resource identifier of the GIS transaction mapping.
• ResourcePath(required): string
  Maximum Length: 1000

  The resource path of the GIS transaction mapping.

{
    "required":[
        "AgencyId",
        "Description",
        "EnabledFlag",
        "GisServiceId",
        "LayerId",
        "LayerName",
        "MappingId",
        "OfferingId",
        "ResourceId",
        "ResourcePath"
    ],
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier for the GIS transaction mapping.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The description of the mapping identifier of the GIS transaction mapping.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the GIS transaction mapping is enabled.",
            "nullable":false
        },
        "GISSyncMapAttr":{
            "title":"GIS transaction mapping attributes",
            "type":"array",
            "description":"This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-post-request"
            }
        },
        "GisServiceId":{
            "title":"Feature Service",
            "maxLength":30,
            "type":"string",
            "description":"The service identifier of the GIS transaction mapping.",
            "nullable":false
        },
        "LayerId":{
            "maxLength":20,
            "type":"string",
            "description":"The layer identifier of the GIS transaction mapping.",
            "nullable":false
        },
        "LayerName":{
            "title":"Layer",
            "maxLength":64,
            "type":"string",
            "description":"The layer name of the GIS transaction mapping.",
            "nullable":false
        },
        "MappingId":{
            "title":"Mapping Name",
            "maxLength":30,
            "type":"string",
            "description":"The mapping identifier of the GIS transaction mapping.",
            "nullable":false
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":50,
            "type":"string",
            "description":"The offering Id of the GIS transaction mapping (e.g. ORA_PSC_OFR_PERMITS, ORA_PSCR_OFR_BUSINESS_LICENSES, ORA_PSCR_OFR_PLANNING_ZONING, ORA_PSCR_OFR_CODE_ENFORCEMENT, ORA_PSC_COMMON).",
            "nullable":false
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The record type identifier of the GIS transaction mapping.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The resource identifier of the GIS transaction mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourcePath":{
            "maxLength":1000,
            "type":"string",
            "description":"The resource path of the GIS transaction mapping.",
            "nullable":false
        }
    }
}

Nested Schema : GIS transaction mapping attributes

Type: array

Title: GIS transaction mapping attributes

This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.

Show Source

• Array of: object schema

{
    "title":"GIS transaction mapping attributes",
    "type":"array",
    "description":"This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  The agency identifier for the GIS transaction mapping attribute.
• DeletedInGisFlag: string
  Title: Deleted in GIS

  Maximum Length: 1

  Indicates whether the attribute has been deleted in GIS.
• GisAttrName: string
  Title: GIS Attributes

  Maximum Length: 30

  The attribute name of the GIS transaction mapping attribute.
• GisAttrType: string
  Title: Type

  Maximum Length: 30

  The attribute type of the GIS transaction mapping attribute (valid values are: esriFieldTypeDate, esriFieldTypeDouble, esriFieldTypeInteger, esriFieldTypeSingle, esriFieldTypeSmallInteger, and esriFieldTypeString.).
• MappingId: string
  Maximum Length: 30

  The mapping identifier of the GIS transaction mapping.
• OpalAttrName: string
  Title: Transaction Attributes

  Maximum Length: 256

  The attribute name of the GIS transaction mapping.
• OpalResource: string
  Maximum Length: 1000

  The resource of the GIS transaction mapping.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier for the GIS transaction mapping attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "DeletedInGisFlag":{
            "title":"Deleted in GIS",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the attribute has been deleted in GIS.",
            "nullable":false
        },
        "GisAttrName":{
            "title":"GIS Attributes",
            "maxLength":30,
            "type":"string",
            "description":"The attribute name of the GIS transaction mapping attribute.",
            "nullable":false
        },
        "GisAttrType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute type of the GIS transaction mapping attribute (valid values are: esriFieldTypeDate, esriFieldTypeDouble, esriFieldTypeInteger, esriFieldTypeSingle, esriFieldTypeSmallInteger, and esriFieldTypeString.).",
            "nullable":false
        },
        "MappingId":{
            "maxLength":30,
            "type":"string",
            "description":"The mapping identifier of the GIS transaction mapping.",
            "nullable":false
        },
        "OpalAttrName":{
            "title":"Transaction Attributes",
            "maxLength":256,
            "type":"string",
            "description":"The attribute name of the GIS transaction mapping.",
            "nullable":true
        },
        "OpalResource":{
            "maxLength":1000,
            "type":"string",
            "description":"The resource of the GIS transaction mapping.",
            "nullable":true
        }
    }
}

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 : publicSectorGISTransactionSyncSetups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The agency identifier for the GIS transaction mapping.
• Description: string
  Title: Description

  Maximum Length: 400

  The description of the mapping identifier of the GIS transaction mapping.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the GIS transaction mapping is enabled.
• GisServiceId: string
  Title: Feature Service

  Maximum Length: 30

  The service identifier of the GIS transaction mapping.
• GISSyncMapAttr: array GIS transaction mapping attributes
  Title: GIS transaction mapping attributes

  This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.
• LayerDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the layer of the GIS transaction mapping.
• LayerId: string
  Maximum Length: 20

  The layer identifier of the GIS transaction mapping.
• LayerName: string
  Title: Layer

  Maximum Length: 64

  The layer name of the GIS transaction mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingId: string
  Title: Mapping Name

  Maximum Length: 30

  The mapping identifier of the GIS transaction mapping.
• OfferingDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the offering identifier of the GIS transaction mapping. For example, Permits, Business Licenses, Planning and Zoning, Code Enforcement, and Public Sector Common.
• OfferingId: string
  Title: Offering

  Maximum Length: 50

  The offering Id of the GIS transaction mapping (e.g. ORA_PSC_OFR_PERMITS, ORA_PSCR_OFR_BUSINESS_LICENSES, ORA_PSCR_OFR_PLANNING_ZONING, ORA_PSCR_OFR_CODE_ENFORCEMENT, ORA_PSC_COMMON).
• RecordTypeId: string
  Maximum Length: 30

  The record type identifier of the GIS transaction mapping.
• ResourceId: integer (int64)
  The resource identifier of the GIS transaction mapping.
• ResourcePath: string
  Maximum Length: 1000

  The resource path of the GIS transaction mapping.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier for the GIS transaction mapping.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The description of the mapping identifier of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the GIS transaction mapping is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "GISSyncMapAttr":{
            "title":"GIS transaction mapping attributes",
            "type":"array",
            "description":"This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-response"
            }
        },
        "GisServiceId":{
            "title":"Feature Service",
            "maxLength":30,
            "type":"string",
            "description":"The service identifier of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "LayerDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the layer of the GIS transaction mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LayerId":{
            "maxLength":20,
            "type":"string",
            "description":"The layer identifier of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "LayerName":{
            "title":"Layer",
            "maxLength":64,
            "type":"string",
            "description":"The layer name of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingId":{
            "title":"Mapping Name",
            "maxLength":30,
            "type":"string",
            "description":"The mapping identifier of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "OfferingDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the offering identifier of the GIS transaction mapping. For example, Permits, Business Licenses, Planning and Zoning, Code Enforcement, and Public Sector Common.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":50,
            "type":"string",
            "description":"The offering Id of the GIS transaction mapping (e.g. ORA_PSC_OFR_PERMITS, ORA_PSCR_OFR_BUSINESS_LICENSES, ORA_PSCR_OFR_PLANNING_ZONING, ORA_PSCR_OFR_CODE_ENFORCEMENT, ORA_PSC_COMMON).",
            "nullable":false,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The record type identifier of the GIS transaction mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The resource identifier of the GIS transaction mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePath":{
            "maxLength":1000,
            "type":"string",
            "description":"The resource path of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : GIS transaction mapping attributes

Type: array

Title: GIS transaction mapping attributes

This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.

Show Source

• Array of: object publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-response

{
    "title":"GIS transaction mapping attributes",
    "type":"array",
    "description":"This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-response"
    }
}

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 : publicSectorGISTransactionSyncSetups-GISSyncMapAttr-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The agency identifier for the GIS transaction mapping attribute.
• DeletedInGisFlag: string
  Title: Deleted in GIS

  Maximum Length: 1

  Indicates whether the attribute has been deleted in GIS.
• GisAttrName: string
  Title: GIS Attributes

  Maximum Length: 30

  The attribute name of the GIS transaction mapping attribute.
• GisAttrType: string
  Title: Type

  Maximum Length: 30

  The attribute type of the GIS transaction mapping attribute (valid values are: esriFieldTypeDate, esriFieldTypeDouble, esriFieldTypeInteger, esriFieldTypeSingle, esriFieldTypeSmallInteger, and esriFieldTypeString.).
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingId: string
  Maximum Length: 30

  The mapping identifier of the GIS transaction mapping.
• OpalAttrName: string
  Title: Transaction Attributes

  Maximum Length: 256

  The attribute name of the GIS transaction mapping.
• OpalResource: string
  Maximum Length: 1000

  The resource of the GIS transaction mapping.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier for the GIS transaction mapping attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "DeletedInGisFlag":{
            "title":"Deleted in GIS",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the attribute has been deleted in GIS.",
            "nullable":false,
            "x-queryable":true
        },
        "GisAttrName":{
            "title":"GIS Attributes",
            "maxLength":30,
            "type":"string",
            "description":"The attribute name of the GIS transaction mapping attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "GisAttrType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute type of the GIS transaction mapping attribute (valid values are: esriFieldTypeDate, esriFieldTypeDouble, esriFieldTypeInteger, esriFieldTypeSingle, esriFieldTypeSmallInteger, and esriFieldTypeString.).",
            "nullable":false,
            "x-queryable":true
        },
        "MappingId":{
            "maxLength":30,
            "type":"string",
            "description":"The mapping identifier of the GIS transaction mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "OpalAttrName":{
            "title":"Transaction Attributes",
            "maxLength":256,
            "type":"string",
            "description":"The attribute name of the GIS transaction mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "OpalResource":{
            "maxLength":1000,
            "type":"string",
            "description":"The resource of the GIS transaction mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

GISSyncMapAttr

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorGISTransactionSyncSetups/{publicSectorGISTransactionSyncSetupsUniqID}/child/GISSyncMapAttr

Parameters:

• publicSectorGISTransactionSyncSetupsUniqID: $request.path.publicSectorGISTransactionSyncSetupsUniqID

This resource is used to view, update, and create GIS transaction mapping attributes. It is also used to specify the attributes of a GIS transaction.

Back to Top