Jump to

• Request
• Response

Create a set of delegate detail information

post

/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail

Request

Path Parameters

• DelegateHeaderId(required): integer(int64)
  The unique identifier of a delegation.

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

• DelegateDetailId: integer (int64)
  The unique identifier of a delegation detail record.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• PrivilegeType: string
  Maximum Length: 30

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoObjectId: string
  Maximum Length: 50

  The unique identifier of a permit or planning and zoning transaction.
• PtoObjectKey: integer (int64)
  The unique key of a permit or planning and zoning transaction.
• PtoObjectType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.
• Status: string
  Title: Status

  Maximum Length: 30

  The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.
• ToPrivilegeType: string
  Title: Change Privilege To

  Maximum Length: 30

  The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.",
            "nullable":false
        },
        "PtoObjectKey":{
            "type":"integer",
            "description":"The unique key of a permit or planning and zoning transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PtoObjectType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.",
            "nullable":false
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The unique identifier of a delegation detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ToPrivilegeType":{
            "title":"Change Privilege To",
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true
        },
        "PrivilegeType":{
            "maxLength":"30",
            "type":"string",
            "description":"The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":false
        },
        "PtoObjectId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a permit or planning and zoning transaction.",
            "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 : publicSectorDelegates-DelegateDetail-item-response

Type: object

Show Source

• DelegateDetailId: integer (int64)
  The unique identifier of a delegation detail record.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• links: array Links
  Title: Links

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

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoObjectId: string
  Maximum Length: 50

  The unique identifier of a permit or planning and zoning transaction.
• PtoObjectKey: integer (int64)
  The unique key of a permit or planning and zoning transaction.
• PtoObjectType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.
• Status: string
  Title: Status

  Maximum Length: 30

  The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.
• ToPrivilegeType: string
  Title: Change Privilege To

  Maximum Length: 30

  The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoObjectKey":{
            "type":"integer",
            "description":"The unique key of a permit or planning and zoning transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PtoObjectType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The unique identifier of a delegation detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ToPrivilegeType":{
            "title":"Change Privilege To",
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivilegeType":{
            "maxLength":"30",
            "type":"string",
            "description":"The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoObjectId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a permit or planning and zoning transaction.",
            "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."
        }
    }
}

Back to Top