Jump to

• Request
• Response

Create a set of meetings

post

/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters

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: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• Classification(required): string
  Title: Classification

  Maximum Length: 3

  The classification of the type of application.
• ContextRecordKey(required): integer (int64)
  Title: Record Key

  The identifier of the parent application for which the meeting is scheduled.
• ContextRecordType: string
  Title: Record Type

  Maximum Length: 30

  Indicates the parent application for which the meeting is scheduled.
• MeetingAgenda: string
  Title: Meeting Agenda

  Maximum Length: 4000

  The identifier of the meeting agenda.
• MeetingAgendaPlain: string (byte)
  The identifier of the meeting agenda that is NOT in rich text format.
• MeetingAgendaText: string (byte)
  The identifier of the meeting agenda that is in rich text format.
• MeetingAttendees: string
  Title: Invitees

  Maximum Length: 4000

  The email IDs of the meeting attendees.
• MeetingDurationHours(required): number
  Title: Meeting Duration in Hours

  The identifier of the duration of the meeting.
• MeetingEndDttm: string (date-time)
  Title: Meeting End Time

  The identifier of the end date and time of the meeting.
• MeetingId: integer (int64)
  Title: Meeting ID

  The unique identifier of the meeting.
• MeetingParticipant: array Meeting Participants
  Title: Meeting Participants

  The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.
• MeetingStartDttm(required): string (date-time)
  Title: Meeting Start Time

  The identifier of the start date and time of the meeting.
• MeetingSubject: string
  Title: Subject

  Maximum Length: 4000

  The subject of the meeting.
• MeetingVenue: string
  Title: Meeting Location

  Maximum Length: 2000

  The identifier of the venue of the meeting.
• RescheduleFlag: string
  Maximum Length: 1

  The identifier of the rescheduled meeting.
• SourceMeetingId: integer (int64)
  Identifies the source of the rescheduled meeting.
• Status: string
  Title: Meeting Status

  Maximum Length: 10

  The identifier of the status of the meeting.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 20

  The subclassification of the type of application.
• Tzname: string
  Title: Time Zone

  Maximum Length: 64

  The identifier of the time zone.

{
    "required":[
        "Classification",
        "ContextRecordKey",
        "MeetingDurationHours",
        "MeetingStartDttm"
    ],
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The classification of the type of application.",
            "nullable":false
        },
        "ContextRecordKey":{
            "title":"Record Key",
            "type":"integer",
            "description":"The identifier of the parent application for which the meeting is scheduled.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContextRecordType":{
            "title":"Record Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the parent application for which the meeting is scheduled.",
            "nullable":true
        },
        "MeetingAgenda":{
            "title":"Meeting Agenda",
            "maxLength":4000,
            "type":"string",
            "description":"The identifier of the meeting agenda.",
            "nullable":true
        },
        "MeetingAgendaPlain":{
            "type":"string",
            "description":"The identifier of the meeting agenda that is NOT in rich text format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MeetingAgendaText":{
            "type":"string",
            "description":"The identifier of the meeting agenda that is in rich text format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MeetingAttendees":{
            "title":"Invitees",
            "maxLength":4000,
            "type":"string",
            "description":"The email IDs of the meeting attendees.",
            "nullable":true
        },
        "MeetingDurationHours":{
            "title":"Meeting Duration in Hours",
            "type":"number",
            "description":"The identifier of the duration of the meeting.",
            "nullable":false,
            "x-hints":{
                "precision":2,
                "scale":1
            }
        },
        "MeetingEndDttm":{
            "title":"Meeting End Time",
            "type":"string",
            "description":"The identifier of the end date and time of the meeting.",
            "format":"date-time",
            "nullable":true
        },
        "MeetingId":{
            "title":"Meeting ID",
            "type":"integer",
            "description":"The unique identifier of the meeting.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "MeetingParticipant":{
            "title":"Meeting Participants",
            "type":"array",
            "description":"The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMeetingRosters-MeetingParticipant-item-post-request"
            }
        },
        "MeetingStartDttm":{
            "title":"Meeting Start Time",
            "type":"string",
            "description":"The identifier of the start date and time of the meeting.",
            "format":"date-time",
            "nullable":false
        },
        "MeetingSubject":{
            "title":"Subject",
            "maxLength":4000,
            "type":"string",
            "description":"The subject of the meeting.",
            "nullable":true
        },
        "MeetingVenue":{
            "title":"Meeting Location",
            "maxLength":2000,
            "type":"string",
            "description":"The identifier of the venue of the meeting.",
            "nullable":true
        },
        "RescheduleFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the rescheduled meeting.",
            "nullable":true
        },
        "SourceMeetingId":{
            "type":"integer",
            "description":"Identifies the source of the rescheduled meeting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Meeting Status",
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the status of the meeting.",
            "nullable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":20,
            "type":"string",
            "description":"The subclassification of the type of application.",
            "nullable":true
        },
        "Tzname":{
            "title":"Time Zone",
            "maxLength":64,
            "type":"string",
            "description":"The identifier of the time zone.",
            "nullable":true
        }
    }
}

Nested Schema : Meeting Participants

Type: array

Title: Meeting Participants

The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.

Show Source

• Array of: object publicSectorMeetingRosters-MeetingParticipant-item-post-request

{
    "title":"Meeting Participants",
    "type":"array",
    "description":"The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMeetingRosters-MeetingParticipant-item-post-request"
    }
}

Nested Schema : publicSectorMeetingRosters-MeetingParticipant-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• IsOrganizer: string
  Title: Organizer

  Maximum Length: 1

  Default Value: N

  The identifier of the meeting organizer.
• MeetingId: integer (int64)
  Title: Meeting ID

  The unique identifier of the meeting to which the participant is associated.
• ParticipantNum: integer (int64)
  Identifies the participant associated with the meeting.
• PartyId: integer (int64)
  Title: Registered Public User ID

  The identifier of the registered user.
• PersonId: integer (int64)
  Title: Worker ID

  The identifier of the agency staff.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "IsOrganizer":{
            "title":"Organizer",
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the meeting organizer.",
            "nullable":true,
            "default":"N"
        },
        "MeetingId":{
            "title":"Meeting ID",
            "type":"integer",
            "description":"The unique identifier of the meeting to which the participant is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "ParticipantNum":{
            "type":"integer",
            "description":"Identifies the participant associated with the meeting.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "PartyId":{
            "title":"Registered Public User ID",
            "type":"integer",
            "description":"The identifier of the registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Worker ID",
            "type":"integer",
            "description":"The identifier of  the agency staff.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The classification of the type of application.
• ContextRecordKey: integer (int64)
  Title: Record Key

  The identifier of the parent application for which the meeting is scheduled.
• ContextRecordType: string
  Title: Record Type

  Maximum Length: 30

  Indicates the parent application for which the meeting is scheduled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeetingAgenda: string
  Title: Meeting Agenda

  Maximum Length: 4000

  The identifier of the meeting agenda.
• MeetingAgendaPlain: string (byte)
  The identifier of the meeting agenda that is NOT in rich text format.
• MeetingAgendaText: string (byte)
  The identifier of the meeting agenda that is in rich text format.
• MeetingAttendees: string
  Title: Invitees

  Maximum Length: 4000

  The email IDs of the meeting attendees.
• MeetingDurationHours: number
  Title: Meeting Duration in Hours

  The identifier of the duration of the meeting.
• MeetingEndDttm: string (date-time)
  Title: Meeting End Time

  The identifier of the end date and time of the meeting.
• MeetingId: integer (int64)
  Title: Meeting ID

  The unique identifier of the meeting.
• MeetingParticipant: array Meeting Participants
  Title: Meeting Participants

  The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.
• MeetingStartDttm: string (date-time)
  Title: Meeting Start Time

  The identifier of the start date and time of the meeting.
• MeetingSubject: string
  Title: Subject

  Maximum Length: 4000

  The subject of the meeting.
• MeetingVenue: string
  Title: Meeting Location

  Maximum Length: 2000

  The identifier of the venue of the meeting.
• RescheduleFlag: string
  Maximum Length: 1

  The identifier of the rescheduled meeting.
• SourceMeetingId: integer (int64)
  Identifies the source of the rescheduled meeting.
• Status: string
  Title: Meeting Status

  Maximum Length: 10

  The identifier of the status of the meeting.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 20

  The subclassification of the type of application.
• Tzname: string
  Title: Time Zone

  Maximum Length: 64

  The identifier of the time zone.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The classification of the type of application.",
            "nullable":false,
            "x-queryable":true
        },
        "ContextRecordKey":{
            "title":"Record Key",
            "type":"integer",
            "description":"The identifier of the parent application for which the meeting is scheduled.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContextRecordType":{
            "title":"Record Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the parent application for which the meeting is scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingAgenda":{
            "title":"Meeting Agenda",
            "maxLength":4000,
            "type":"string",
            "description":"The identifier of the meeting agenda.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingAgendaPlain":{
            "type":"string",
            "description":"The identifier of the meeting agenda that is NOT in rich text format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MeetingAgendaText":{
            "type":"string",
            "description":"The identifier of the meeting agenda that is in rich text format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MeetingAttendees":{
            "title":"Invitees",
            "maxLength":4000,
            "type":"string",
            "description":"The email IDs of the meeting attendees.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingDurationHours":{
            "title":"Meeting Duration in Hours",
            "type":"number",
            "description":"The identifier of the duration of the meeting.",
            "nullable":false,
            "x-hints":{
                "precision":2,
                "scale":1
            },
            "x-queryable":true
        },
        "MeetingEndDttm":{
            "title":"Meeting End Time",
            "type":"string",
            "description":"The identifier of the end date and time of the meeting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingId":{
            "title":"Meeting ID",
            "type":"integer",
            "description":"The unique identifier of the meeting.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeetingParticipant":{
            "title":"Meeting Participants",
            "type":"array",
            "description":"The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMeetingRosters-MeetingParticipant-item-response"
            }
        },
        "MeetingStartDttm":{
            "title":"Meeting Start Time",
            "type":"string",
            "description":"The identifier of the start date and time of the meeting.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MeetingSubject":{
            "title":"Subject",
            "maxLength":4000,
            "type":"string",
            "description":"The subject of the meeting.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingVenue":{
            "title":"Meeting Location",
            "maxLength":2000,
            "type":"string",
            "description":"The identifier of the venue of the meeting.",
            "nullable":true,
            "x-queryable":true
        },
        "RescheduleFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the rescheduled meeting.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMeetingId":{
            "type":"integer",
            "description":"Identifies the source of the rescheduled meeting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Meeting Status",
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the status of the meeting.",
            "nullable":true,
            "x-queryable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":20,
            "type":"string",
            "description":"The subclassification of the type of application.",
            "nullable":true,
            "x-queryable":true
        },
        "Tzname":{
            "title":"Time Zone",
            "maxLength":64,
            "type":"string",
            "description":"The identifier of the time zone.",
            "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 : Meeting Participants

Type: array

Title: Meeting Participants

The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.

Show Source

• Array of: object publicSectorMeetingRosters-MeetingParticipant-item-response

{
    "title":"Meeting Participants",
    "type":"array",
    "description":"The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMeetingRosters-MeetingParticipant-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorMeetingRosters-MeetingParticipant-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• IsOrganizer: string
  Title: Organizer

  Maximum Length: 1

  Default Value: N

  The identifier of the meeting organizer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeetingId: integer (int64)
  Title: Meeting ID

  The unique identifier of the meeting to which the participant is associated.
• ParticipantNum: integer (int64)
  Identifies the participant associated with the meeting.
• PartyId: integer (int64)
  Title: Registered Public User ID

  The identifier of the registered user.
• PersonId: integer (int64)
  Title: Worker ID

  The identifier of the agency staff.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "IsOrganizer":{
            "title":"Organizer",
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the meeting organizer.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "MeetingId":{
            "title":"Meeting ID",
            "type":"integer",
            "description":"The unique identifier of the meeting to which the participant is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ParticipantNum":{
            "type":"integer",
            "description":"Identifies the participant associated with the meeting.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Registered Public User ID",
            "type":"integer",
            "description":"The identifier of the registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Worker ID",
            "type":"integer",
            "description":"The identifier of  the agency staff.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Links

MeetingParticipant

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipant

Parameters:

• MeetingId: $request.path.MeetingId

The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.

Back to Top