ルート・スキーマ : lightboxDocuments-sharedPersons
タイプ: object
ソースを表示
{
"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/lightboxDocuments-sharedPersons-item-response"
}
}
}
}
ネストされたスキーマ : lightboxDocuments-sharedPersons-item-response
タイプ: object
ソースを表示
{
"type":"object",
"properties":{
"OrganizationName":{
"title":"Organization",
"maxLength":240,
"type":"string",
"description":"The organization name of the person with whom the document was shared.",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"LastUpdatedBy":{
"title":"Last Updated By",
"maxLength":64,
"type":"string",
"description":"The date when the record was last updated.",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"CreationDate":{
"title":"Creation Date",
"type":"string",
"description":"The date when the record was created.",
"format":"date-time",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"PersonName":{
"title":"Name",
"maxLength":450,
"type":"string",
"description":"The name of the person with whom the document was shared.",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"SharedDate":{
"title":"Shared Date",
"type":"string",
"description":"The date when the document was shared.",
"format":"date-time",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"CreatedBy":{
"title":"Created By",
"maxLength":64,
"type":"string",
"description":"The user who created the record.",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"PersonLastName":{
"title":"Last Name",
"maxLength":150,
"type":"string",
"description":"The last name of the person with whom the document was shared.",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"LightboxDocumentId":{
"title":"Document ID",
"maxLength":64,
"type":"string",
"description":"The unique identifier of the Lightbox document.",
"nullable":false,
"x-queryable":true
},
"IsJointOwnerFlag":{
"title":"Owner",
"maxLength":1,
"type":"boolean",
"description":"Indicates if the party with whom the document has been shared is one of the owners of the document.",
"nullable":true,
"x-queryable":true
},
"PersonFirstName":{
"title":"First Name",
"maxLength":150,
"type":"string",
"description":"The first name of the person with whom the document was shared.",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"SharedUserPartyId":{
"title":"Party ID",
"type":"integer",
"description":"The unique identifier of the party with whom the document has been shared.",
"format":"int64",
"nullable":false,
"x-hints":{
"precision":18
},
"x-queryable":true
},
"EmailAddress":{
"title":"Primary Email",
"maxLength":320,
"type":"string",
"description":"The email ID of the person with whom the document was shared.",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"DeleteFlag":{
"type":"boolean",
"description":"Indicates if the current user has the permission to delete the shared person record.",
"nullable":true,
"readOnly":true,
"x-queryable":false,
"x-hints":{
"dependencies":[
"DocumentStatusCode",
"IsOriginalOwnerRecord",
"MyDocumentOwnerFlag",
"SharedUserPartyId"
]
}
},
"PersonTitle":{
"title":"Title",
"maxLength":60,
"type":"string",
"description":"The title of the person with whom the document was shared.",
"nullable":true,
"readOnly":true,
"x-queryable":true
},
"ReportsTo":{
"title":"Manager",
"maxLength":360,
"type":"string",
"description":"The manager of the person with whom the document was shared.",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"links":{
"title":"Links",
"type":"array",
"description":"The link relations associated with the resource instance.",
"items":{
"$ref":"#/components/schemas/link"
}
},
"LastUpdateDate":{
"title":"Last Updated Date",
"type":"string",
"description":"The user who last updated the record.",
"format":"date-time",
"nullable":false,
"readOnly":true,
"x-queryable":true
},
"LastUpdateLogin":{
"title":"Last Update Login",
"maxLength":32,
"type":"string",
"description":"The login of the user who last updated the record.",
"nullable":true,
"readOnly":true,
"x-queryable":true
}
}
}
ネストされたスキーマ : リンク
タイプ: object
ソースを表示
-
href: string
タイトル: hyperlink reference
関連リソースへのURI。
-
kind: string
タイトル: kind
許可された値: [ "collection", "item", "describe", "other" ]
関連リソースの種類。
-
name: string
タイトル: name
関連リソースへのリンクの名前。
-
properties: object properties
-
rel: string
タイトル: relation
許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: 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."
}
}
}
}
}