Jump to

• Request
• Response

Get all activities

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlannerActivities

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AllAssignedActivitiesFinder: Finds activities for all planners that match the specified key criteria.
    Finder Variables:
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • AllNextWeekActivitiesFinder: Finds next week's activities for all planners that match the specified criteria.
    Finder Variables:
    • bNextWeekMonday; string; The Monday date for next week.
    • bNextWeekSunday; string; The Sunday date for next week.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • AllOverdueActivitiesFinder: Finds overdue activities for all planners that match the specified criteria.
    Finder Variables:
    • bCurrentDate; string; The current date.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • AllThisWeekActivitiesFinder: Finds this week's activities for all planners that match the specified criteria.
    Finder Variables:
    • bMondayDate; string; The Monday date for this week.
    • bSundayDate; string; The Sunday date for this week.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • AllTodayActivitiesFinder: Finds today's activities for all planners that match the specified criteria.
    Finder Variables:
    • bCurrentDate; string; The current date.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • AssignedActivitiesFinder: Finds activities where the planner matches the specified key criteria.
    Finder Variables:
    • bAssigneeId; integer; The unique identifier for the assignee.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • NextWeekActivitiesFinder: Finds next week's activities that match the specified criteria.
    Finder Variables:
    • bAssigneeId; integer; The unique identifier for the assignee.
    • bNextWeekMonday; string; The Monday date for next week.
    • bNextWeekSunday; string; The Sunday date for next week.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • OverdueActivitiesFinder: Finds the overdue activities that match the specified criteria.
    Finder Variables:
    • bAssigneeId; integer; The unique identifier for the assignee.
    • bCurrentDate; string; The current date.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • PrimaryKey: Finds the activities that match the specified primary key criteria.
    Finder Variables:
    • ActivityLogKey; integer; The unique identifier for the activity log.
  • ThisWeekActivitiesFinder: Finds this week's activities that match the specified criteria.
    Finder Variables:
    • bAssigneeId; integer; The unique identifier for the assignee.
    • bMondayDate; string; The Monday date for this week.
    • bSundayDate; string; The Sunday date for this week.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • TodayActivitiesFinder: Finds today's activities that match the specified criteria.
    Finder Variables:
    • bAssigneeId; integer; The unique identifier for the assignee.
    • bCurrentDate; string; The current date.
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • simpleSearchAllActivities: Finds the activities that match the specified primary key criteria.
    Finder Variables:
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
  • simpleSearchFinder: Finds the activities that match the specified primary key criteria.
    Finder Variables:
    • value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActivityGroupId; string; The unique identifier for the activity group.
  • ActivityId; string; The unique identifier for the activity.
  • ActivityLogId; string; A logical ID for the activity log transaction.
  • ActivityLogKey; integer; The unique identifier for an activity. This number is created using autonumbering.
  • ActivityName; string; The activity log short name.
  • ActivityStatus; string; The activity status.
  • ActivityStatusDesc; string; The description for an activity status.
  • ActualCompletionDate; string; The actual completion date for an activity.
  • Address1; string; The first line of the address.
  • Address2; string; The second line of the address.
  • Address3; string; The third line of the address.
  • Address4; string; The fourth line of the address.
  • AgencyId; integer; The unique identifier for the agency.
  • ApplicationDescription; string; The application description.
  • ApplicationStatus; string; The application status.
  • AssignedTo; string; The planner ID to whom the activity is assigned.
  • AssigneeId; integer; The PERSON_ID key of the person assigned to work on the activity. This ID comes from the table PER_USERS.
  • AssigneeName; string; The name of the planner to whom the activity is assigned.
  • AssigneeUserid; string; The user name of the person assigned to work on the activity.
  • BaseDate; string; The base date for an activity.
  • City; string; The city for the address.
  • Country; string; The country for the address.
  • County; string; The county of the address.
  • CurrentRowFlag; string; Indicates the current row for the activity.
  • Description; string; The activity log description.
  • DuedateBasis; string; The unique identifier for the due date basis calculation.
  • DuedateBasisDesc; string; The description for due date basis.
  • DuedateDuration; integer; The due date duration.
  • LeadLagIndicator; string; The unique identifier for lead lag.
  • OccuranceCount; integer; The occurrence count of an activity.
  • PlannedDueDate; string; The due date for an activity.
  • PostalCode; string; The postal code for the address.
  • RecordId; string; A logical ID for the planning and zoning application transaction.
  • RecordKey; integer; The unique identifier for an application. This number is created using autonumbering.
  • RecordType; string; The description for an application.
  • RecordTypeCode; string; The unique identifier for an application type.
  • RecordTypeId; string; The logical ID for the application.
  • RedoFlag; string; Indicates a redo activity.
  • ResubmitFlag; string; Indicates whether the activity can be resubmitted.
  • ResubmittedFlag; string; Indicates whether the activity has been resubmitted.
  • State; string; The state for the address.
  • StreetName; string; The street name of the address.
  • StreetNumber; string; The street number of the address.
  • Subclassification; string; The application type classification that represents the planning and zoning application.
  • SystemStatus; string; The system status.
  • TranType; string; The type of transaction for an application.
  • TranTypeDescr; string; The description for type of transaction for an application.
  • TransactionReferenceId; string; A logical ID for the transaction.
  • TransactionReferenceKey; integer; The unique identifier for planning and zoning transaction. This number is created using autonumbering.
  • UnitNumber; string; The unit number of the address.
  • UpdatedByUser; string; The name of the user who last updated the row.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : publicSectorPlannerActivities

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPlannerActivities-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPlannerActivities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPlannerActivities-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 : publicSectorPlannerActivities-item-response

Type: object

Show Source

• ActivityGroupId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the activity group.
• ActivityId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the activity.
• ActivityLogId: string
  Read Only: true

  Maximum Length: 65

  A logical ID for the activity log transaction.
• ActivityLogKey: integer (int64)
  Read Only: true

  The unique identifier for an activity. This number is created using autonumbering.
• ActivityName: string
  Read Only: true

  Maximum Length: 255

  The activity log short name.
• ActivityStatus: string
  Read Only: true

  Maximum Length: 30

  The activity status.
• ActivityStatusDesc: string
  Read Only: true

  Maximum Length: 15

  The description for an activity status.
• ActualCompletionDate: string (date-time)
  Read Only: true

  The actual completion date for an activity.
• Address1: string
  Read Only: true

  Maximum Length: 240

  The first line of the address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second line of the address.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line of the address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the address.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier for the agency.
• ApplicationDescription: string
  Read Only: true

  Maximum Length: 1000

  The application description.
• ApplicationStatus: string
  Read Only: true

  Maximum Length: 15

  The application status.
• AssignedTo: string
  Read Only: true

  Maximum Length: 240

  The planner ID to whom the activity is assigned.
• AssigneeId: integer (int64)
  Read Only: true

  The PERSON_ID key of the person assigned to work on the activity. This ID comes from the table PER_USERS.
• AssigneeName: string
  Read Only: true

  Maximum Length: 240

  The name of the planner to whom the activity is assigned.
• AssigneeUserid: string
  Read Only: true

  Maximum Length: 64

  The user name of the person assigned to work on the activity.
• BaseDate: string (date-time)
  Read Only: true

  The base date for an activity.
• City: string
  Read Only: true

  Maximum Length: 60

  The city for the address.
• Country: string
  Read Only: true

  Maximum Length: 3

  The country for the address.
• County: string
  Read Only: true

  Maximum Length: 60

  The county of the address.
• CurrentRowFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates the current row for the activity.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The activity log description.
• DuedateBasis: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the due date basis calculation.
• DuedateBasisDesc: string
  Read Only: true

  Maximum Length: 80

  The description for due date basis.
• DuedateDuration: integer (int32)
  Read Only: true

  The due date duration.
• LeadLagIndicator: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for lead lag.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OccuranceCount: integer (int32)
  Read Only: true

  The occurrence count of an activity.
• PlannedDueDate: string (date)
  Read Only: true

  The due date for an activity.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code for the address.
• RecordId: string
  Read Only: true

  Maximum Length: 50

  A logical ID for the planning and zoning application transaction.
• RecordKey: integer (int64)
  Read Only: true

  The unique identifier for an application. This number is created using autonumbering.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The description for an application.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The unique identifier for an application type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The logical ID for the application.
• RedoFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates a redo activity.
• ResubmitFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the activity can be resubmitted.
• ResubmittedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the activity has been resubmitted.
• State: string
  Read Only: true

  Maximum Length: 60

  The state for the address.
• StreetName: string
  Read Only: true

  Maximum Length: 240

  The street name of the address.
• StreetNumber: string
  Read Only: true

  Maximum Length: 20

  The street number of the address.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The application type classification that represents the planning and zoning application.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The system status.
• TransactionReferenceId: string
  Read Only: true

  Maximum Length: 50

  A logical ID for the transaction.
• TransactionReferenceKey: integer (int64)
  Read Only: true

  The unique identifier for planning and zoning transaction. This number is created using autonumbering.
• TranType: string
  Read Only: true

  Maximum Length: 30

  The type of transaction for an application.
• TranTypeDescr: string
  Read Only: true

  Maximum Length: 200

  The description for type of transaction for an application.
• UnitNumber: string
  Read Only: true

  Maximum Length: 30

  The unit number of the address.
• UpdatedByUser: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.

{
    "type":"object",
    "properties":{
        "ActivityLogKey":{
            "type":"integer",
            "description":"The unique identifier for an activity. This number is created using autonumbering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The application type classification that represents the planning and zoning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetName":{
            "maxLength":"240",
            "type":"string",
            "description":"The street name of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TranType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of transaction for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "maxLength":"64",
            "type":"string",
            "description":"The user name of the person assigned to work on the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The activity log short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier for an application. This number is created using autonumbering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BaseDate":{
            "type":"string",
            "description":"The base date for an activity.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeId":{
            "type":"integer",
            "description":"The PERSON_ID key of the person assigned to work on the activity. This ID comes from the table PER_USERS.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResubmittedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the activity has been resubmitted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedByUser":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DuedateBasisDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"The description for due date basis.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the activity group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The application description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadLagIndicator":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for lead lag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The activity status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The activity log description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ActivityStatusDesc":{
            "maxLength":"15",
            "type":"string",
            "description":"The description for an activity status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionReferenceKey":{
            "type":"integer",
            "description":"The unique identifier for planning and zoning transaction. This number is created using autonumbering.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OccuranceCount":{
            "type":"integer",
            "description":"The occurrence count of an activity.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedDueDate":{
            "type":"string",
            "description":"The due date for an activity.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier for an application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The description for an application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The logical ID for the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"A logical ID for the planning and zoning application transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"The actual completion date for an activity.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityLogId":{
            "maxLength":"65",
            "type":"string",
            "description":"A logical ID for the activity log transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The system status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the planner to whom the activity is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DuedateBasis":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the due date basis calculation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResubmitFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the activity can be resubmitted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TranTypeDescr":{
            "maxLength":"200",
            "type":"string",
            "description":"The description for type of transaction for an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentRowFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the current row for the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedTo":{
            "maxLength":"240",
            "type":"string",
            "description":"The planner ID to whom the activity is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RedoFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates a redo activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The application status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionReferenceId":{
            "maxLength":"50",
            "type":"string",
            "description":"A logical ID for the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"The due date duration.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "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