API docs by Redocly

Nodeblocks Organization Service Default Adapter API Specification (1.0)

Download OpenAPI specification:Download

Basal.dev: gen@basal.dev URL: https://www.basal.dev/ Terms of Service

API documentation for OrganizationService default adapter.

App

Get app status

Retrieves app status information.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "packageInfo": {
    }
}

Organization

Get organizations

Retrieve the organization list

This operation requires

  • valid Authorization token has been specified
  • Authorization token have super user permission
Authorizations:
bearerAuthx-nb-fingerprint
query Parameters
$top
integer

number of object want to fetch

$skip
integer

number of object want to skip

$filter
string

Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

Operator Description Example
( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
not Logical negation not totalPrice le 3.5
gt Greater than totalPrice gt 20
ge Greater than or equal totalPrice ge 10
lt Less than totalPrice lt 20
le Less than or equal totalPrice le 100
eq Equal customer.userId eq '01234567890123456789ab'
ne Not equal status ne 'CANCELED'
and Logical and totalPrice le 200 and totalPrice gt 3.5
or Logical or totalPrice le 3.5 or totalPrice gt 200
$skip
integer

number of object want to skip

$expand
string

Expands and returns related data to a field. The expand parameter allows clients to request related resources in a single request. The expand parameter value is a comma-separated list of related resources to include in the response. The expand parameter supports the following fields:

  • 'parent': Returns the parent of the organization.
  • 'children': Returns the children of the organization as an array. Only the first 25 children are returned.
$nextToken
string

Token for get next batch of list data

$previousToken
string

Token for get previous batch of list data

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "count": 100,
  • "@nextLink": "http://localhost:3005/orders?nextToken=xxx",
  • "@previousLink": "http://localhost:3005/orders?previousToken=xxx",
  • "value": [
    ]
}

Create organization

Create an organization

This operation requires

  • Authorization token has been specified
  • Authorization token have super user permission or
    • userId inside Authorization token equals the ownerId in the request body
    • userId inside Authorization token has emailVerified
    • userId inside Authorization token has typeId=010
Authorizations:
bearerAuthx-nb-fingerprint
Request Body schema: application/json
name
required
string (organizationName.field) <= 256 characters

The organization's name.

typeId
required
string (organizationTypeId.field)
Enum: "010" "011"

Type code of the organization

  • 010 - General company
  • 011 - Solo proprietorship
ownerId
required
string

Owner of the organization (associated with user-service user.id field) If the user is a system admin, this field is optional

parentId
string (objectId.field) ^[0-9a-z]{24}$

The parent organization ID. When this is null, the organization is a root organization. This can only be configured if the user is a system admin Organizations that have users cannot be made parents.

description
string (organizationDescription.field)

Detailed description of the organization.

branchName
string (organizationBranchName.field)

The specific branch this organization represents.

pictureUrl
string <uri> (uri.field)

A URI for a resource

postalCode
string (organizationPostalCode.field)
addressLine1
string (organizationAddressLine1.field)
addressLine2
string (organizationAddressLine2.field)
addressLine3
string (organizationAddressLine3.field)
certificateImageData
string (imageData.field)

A Base64 string containing image data.

iconImageData
string (imageData.field)

A Base64 string containing image data.

phoneNumber
string (organizationPhoneNumber.field)

Contact number for the organization.

size
string (organizationSize.field)

Scope of the organization (employee count)

numberOfProjects
string (organizationNumberOfProjects.field)
url
string (organizationUrl.field) <= 256 characters

The organization's website URL.

Array of objects (qualification.field)

Qualifications that need to be reviewed to change

Array of objects (qualification.field)

Qualification that user can change without review

customFields
object (customFields.field)

Custom fields added to the customFields options in createOrganizationDefaultAdapter.

Responses

Request samples

Content type
application/json
{
  • "name": "アドム法律事務所",
  • "typeId": "010",
  • "ownerId": "a123123",
  • "parentId": "b012345",
  • "description": "アドム法律事務所",
  • "branchName": "世田谷本社",
  • "pictureUrl": "string",
  • "postalCode": "1500000",
  • "addressLine1": "東京都",
  • "phoneNumber": "09011111111",
  • "size": "100~200",
  • "numberOfProjects": "100",
  • "certifiedQualifications": [
    ],
  • "qualifications": [
    ],
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "0123456789ab0123456789ab",
  • "name": "アドム法律事務所",
  • "typeId": "010",
  • "description": "アドム法律事務所",
  • "branchName": "世田谷本社",
  • "pictureUrl": "xxxx.com/yyyyy",
  • "postalCode": "1500000",
  • "addressLine1": "東京都",
  • "addressLine2": "世田谷区",
  • "addressLine3": "松原２丁目",
  • "certificateImageUri": "xxxx.com/yyyyy",
  • "iconImageUri": "xxxx.com/yyyyy",
  • "logoImageUri": "xxxx.com/yyyyy",
  • "phoneNumber": "09011111111",
  • "size": "100~200",
  • "numberOfProjects": "100",
  • "certifiedQualifications": [
    ],
  • "qualifications": [
    ],
  • "status": "normal",
  • "auditStatus": "waiting_for_review",
  • "reviewStats": {
    },
  • "url": "https://www.organization.example",
  • "ancestorIds": [
    ],
  • "ancestorNamePath": ",Parent,アドム法律事務所,",
  • "childrenCount": 0,
  • "depth": 1,
  • "parentId": "0123456789ab0123456789ab",
  • "customFields": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Get organization by ID

Retrieve information of the organization with the matching organization ID.

This operation requires

  • Authorization token is a valid token
Authorizations:
bearerAuthx-nb-fingerprint
path Parameters
orgId
required
string^[0-9a-z]{24}$
Example: 0123456789ab0123456789ab

A unique identifier for an organization.

query Parameters
$expand
string

Expands and returns related data to a field. The expand parameter allows clients to request related resources in a single request. The expand parameter value is a comma-separated list of related resources to include in the response. The expand parameter supports the following fields:

  • 'parent': Returns the parent of the organization.
  • 'children': Returns the children of the organization as an array. Only the first 25 children are returned.

Responses

Response samples

Content type
application/json
{
  • "id": "0123456789ab0123456789ab",
  • "name": "アドム法律事務所",
  • "typeId": "010",
  • "description": "アドム法律事務所",
  • "branchName": "世田谷本社",
  • "pictureUrl": "xxxx.com/yyyyy",
  • "postalCode": "1500000",
  • "addressLine1": "東京都",
  • "addressLine2": "世田谷区",
  • "addressLine3": "松原２丁目",
  • "certificateImageUri": "xxxx.com/yyyyy",
  • "iconImageUri": "xxxx.com/yyyyy",
  • "logoImageUri": "xxxx.com/yyyyy",
  • "phoneNumber": "09011111111",
  • "size": "100~200",
  • "numberOfProjects": "100",
  • "certifiedQualifications": [
    ],
  • "qualifications": [
    ],
  • "status": "normal",
  • "auditStatus": "waiting_for_review",
  • "reviewStats": {
    },
  • "url": "https://www.organization.example",
  • "ancestorIds": [
    ],
  • "ancestorNamePath": ",Parent,アドム法律事務所,",
  • "childrenCount": 0,
  • "depth": 1,
  • "parentId": "0123456789ab0123456789ab",
  • "customFields": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Update organization information

Update organization's information of given organization ID

This operation requires

  • valid Authorization token has been specified
  • Authorization token have super user permission or
    • userId inside Authorization token has owner or admin role in the organization
    • userId inside Authorization token has emailVerified
  • if status / auditStatus is updated, then Authorization token has to have super user permission
Authorizations:
bearerAuthx-nb-fingerprint
path Parameters
orgId
required
string^[0-9a-z]{24}$
Example: 0123456789ab0123456789ab

A unique identifier for an organization.

Request Body schema: application/json
parentId
string (objectId.field) ^[0-9a-z]{24}$

The parent organization ID. When this is null, the organization is a root organization. This can only be configured if the user is a system admin. Organizations that have users cannot be made parents.

description
string (organizationDescription.field)

Detailed description of the organization.

pictureUrl
string <uri> (uri.field)

A URI for a resource

phoneNumber
string (organizationPhoneNumber.field)

Contact number for the organization.

size
string (organizationSize.field)

Scope of the organization (employee count)

numberOfProjects
string (organizationNumberOfProjects.field)
Array of objects (Qualification)
iconImageData
string (imageData.field)

A Base64 string containing image data.

logoImageData
string (imageData.field)

A Base64 string containing image data.

url
string (organizationUrl.field) <= 256 characters

The organization's website URL.

customFields
object (customFields.field)

Custom fields added to the customFields options in createOrganizationDefaultAdapter.

Responses

Request samples

Content type
application/json
{
  • "description": "アドム法律事務所",
  • "branchName": "世田谷本社",
  • "pictureUrl": "string",
  • "postalCode": "1500000",
  • "addressLine1": "東京都世田谷区松原２丁目",
  • "phoneNumber": "09011111111",
  • "size": "100~200",
  • "numberOfProjects": "100",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "0123456789ab0123456789ab",
  • "name": "アドム法律事務所",
  • "typeId": "010",
  • "description": "アドム法律事務所",
  • "branchName": "世田谷本社",
  • "pictureUrl": "xxxx.com/yyyyy",
  • "postalCode": "1500000",
  • "addressLine1": "東京都",
  • "addressLine2": "世田谷区",
  • "addressLine3": "松原２丁目",
  • "certificateImageUri": "xxxx.com/yyyyy",
  • "iconImageUri": "xxxx.com/yyyyy",
  • "logoImageUri": "xxxx.com/yyyyy",
  • "phoneNumber": "09011111111",
  • "size": "100~200",
  • "numberOfProjects": "100",
  • "certifiedQualifications": [
    ],
  • "qualifications": [
    ],
  • "status": "normal",
  • "auditStatus": "waiting_for_review",
  • "reviewStats": {
    },
  • "url": "https://www.organization.example",
  • "ancestorIds": [
    ],
  • "ancestorNamePath": ",Parent,アドム法律事務所,",
  • "childrenCount": 0,
  • "depth": 1,
  • "parentId": "0123456789ab0123456789ab",
  • "customFields": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Delete organization

Delete organization of giving organization ID

This operation requires

  • Authorization token has been specified
  • Authorization token have super user permission or
    • userId inside Authorization token has emailVerified
    • userId inside Authorization token has owner role in the organization
Authorizations:
bearerAuthx-nb-fingerprint
path Parameters
orgId
required
string^[0-9a-z]{24}$
Example: 0123456789ab0123456789ab

A unique identifier for an organization.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create change request to update organization

Use this API to request some changes to organization information, for example:

  • name
  • certifiedQualifications
  • ...
    • Because some of the information update need to check by system admin, and cannot update directly from clients.

    This operation requires

    • valid Authorization token has been specified
    • Authorization token have super user permission or
      • userId inside Authorization token have owner role in the organization
    Authorizations:
    x-nb-fingerprintbearerAuth
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    Request Body schema: application/json
    name
    string (organizationName.field) <= 256 characters

    The organization's name.

    typeId
    string (organizationTypeId.field)
    Enum: "010" "011"

    Type code of the organization

    • 010 - General company
    • 011 - Solo proprietorship
    branchName
    string (organizationBranchName.field)

    The specific branch this organization represents.

    postalCode
    string (organizationPostalCode.field)
    addressLine1
    string (organizationAddressLine1.field)
    addressLine2
    string (organizationAddressLine2.field)
    addressLine3
    string (organizationAddressLine3.field)
    certificateImageData
    string (imageData.field)

    A Base64 string containing image data.

    Array of objects (Qualification)

    Qualifications that need to be reviewed to change

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "アドム法律事務所",
    • "typeId": "010",
    • "postalCode": "1510053",
    • "branchName": "東京営業所",
    • "addressLine1": "addressLine1",
    • "certifiedQualifications": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    Get change requests for organization

    Get the change requests list of the organizations. Ordered by updated timestamp, desc

    This operation requires

    • valid Authorization token has been specified
    • Authorization token have super user permission or
      • userId inside Authorization token have owner role in the organization
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    $filter
    string

    Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

    Operator Description Example
    ( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
    not Logical negation not totalPrice le 3.5
    gt Greater than totalPrice gt 20
    ge Greater than or equal totalPrice ge 10
    lt Less than totalPrice lt 20
    le Less than or equal totalPrice le 100
    eq Equal customer.userId eq '01234567890123456789ab'
    ne Not equal status ne 'CANCELED'
    and Logical and totalPrice le 200 and totalPrice gt 3.5
    or Logical or totalPrice le 3.5 or totalPrice gt 200
    $orderBy
    string

    Return sorted items based on property values. It can contain a comma-separated list of expressions. The expression may include the suffix "asc" for ascending or "desc" for descending, separated from the property name by one or more spaces. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. The sort order is the inherent order for the type of the property.

    Examples:

    This is just a reference, the actual values may vary based on the service implementation. Return all items sorted by name in descending order and a secondary sort order of updatedAt in ascending order.

    $orderBy=name desc,updatedAt
    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    Responses

    Response samples

    Content type
    application/json
    {
    • "total": 100,
    • "count": 100,
    • "@nextLink": "http://localhost:3005/orders?nextToken=xxx",
    • "@previousLink": "http://localhost:3005/orders?previousToken=xxx",
    • "value": [
      ]
    }

    Role

    Get users for organization

    Get users and their roles under the organization.

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token has owner role in the organization
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    Responses

    Response samples

    Content type
    application/json
    {
    • "total": 100,
    • "count": 100,
    • "value": [
      ]
    }

    Create or update user roles for an organization

    Specify a list of userIds and roles in the body.
    If userIds exist then update the role. If userIds do not exist then add to the organization. Does not remove user roles.

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token has owner role in the organization

    This operation cannot be performed if an organization has a child organization.

    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    Request Body schema: application/json
    Array
    id
    required
    string (objectId.field) ^[0-9a-z]{24}$

    A 24 character hexadecimal string value.

    role
    required
    string (userRole.field)
    Enum: "owner" "admin" "member" "guest"

    Role of the user for this organization. Many apis are restricted to owner users only.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    Remove user's role on the organization

    Remove user's role of the organization

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token has owner role in the organization
    • user is not removing the last owner of the organization
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    userId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for a user

    Responses

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    Get user role in the organization

    Get user role in the organization

    This operation requires

    • valid Authorization token has been specified in request header
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    userId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for a user

    Responses

    Response samples

    Content type
    application/json
    {
    • "role": "owner"
    }

    Get organizations for user

    Get the organizations which a user is invited to.

    This operation requires

    • valid Authorization token has been specified
    • Authorization token have super user permission or
      • userId inside Authorization token equals the userId in the request path
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    userId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for a user

    query Parameters
    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    roles
    string

    roles of user in organization, comma separated

    $filter
    string

    Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

    Operator Description Example
    ( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
    not Logical negation not totalPrice le 3.5
    gt Greater than totalPrice gt 20
    ge Greater than or equal totalPrice ge 10
    lt Less than totalPrice lt 20
    le Less than or equal totalPrice le 100
    eq Equal customer.userId eq '01234567890123456789ab'
    ne Not equal status ne 'CANCELED'
    and Logical and totalPrice le 200 and totalPrice gt 3.5
    or Logical or totalPrice le 3.5 or totalPrice gt 200
    $orderBy
    string

    Return sorted items based on property values. It can contain a comma-separated list of expressions. The expression may include the suffix "asc" for ascending or "desc" for descending, separated from the property name by one or more spaces. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. The sort order is the inherent order for the type of the property.

    Examples:

    This is just a reference, the actual values may vary based on the service implementation. Return all items sorted by name in descending order and a secondary sort order of updatedAt in ascending order.

    $orderBy=name desc,updatedAt
    $expand
    string

    Expands and returns related data to a field. The expand parameter allows clients to request related resources in a single request. The expand parameter value is a comma-separated list of related resources to include in the response. The expand parameter supports the following fields:

    • 'parent': Returns the parent of the organization.
    • 'children': Returns the children of the organization as an array. Only the first 25 children are returned.
    $nextToken
    string

    Token for get next batch of list data

    $previousToken
    string

    Token for get previous batch of list data

    Responses

    Response samples

    Content type
    application/json
    {
    • "total": 100,
    • "count": 100,
    • "@nextLink": "http://localhost:3005/orders?nextToken=xxx",
    • "@previousLink": "http://localhost:3005/orders?previousToken=xxx",
    • "value": [
      ]
    }

    Attachment

    Create a new organization attachment

    Create an organization attachment

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token belongs to the organization
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    Request Body schema: application/json
    Array
    objectId
    required
    string (objectId.field) ^[0-9a-z]{24}$

    A 24 character hexadecimal string value.

    type
    required
    string (attachmentType.field)

    The file type of the attachment

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "id": "0123456789ab0123456789ab",
    • "orgId": "0123456789ab0123456789ab",
    • "ownerId": "0123456789ab0123456789ab",
    • "ownerType": "organization",
    • "isPublic": false,
    • "type": "jpg",
    • "url": "xxxx.com/yyyyy"
    }

    Get a list of organization attachments

    Get list of organization attachment

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token belongs to the organization
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    $filter
    string

    Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

    Operator Description Example
    ( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
    not Logical negation not totalPrice le 3.5
    gt Greater than totalPrice gt 20
    ge Greater than or equal totalPrice ge 10
    lt Less than totalPrice lt 20
    le Less than or equal totalPrice le 100
    eq Equal customer.userId eq '01234567890123456789ab'
    ne Not equal status ne 'CANCELED'
    and Logical and totalPrice le 200 and totalPrice gt 3.5
    or Logical or totalPrice le 3.5 or totalPrice gt 200
    $orderBy
    string

    Return sorted items based on property values. It can contain a comma-separated list of expressions. The expression may include the suffix "asc" for ascending or "desc" for descending, separated from the property name by one or more spaces. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. The sort order is the inherent order for the type of the property.

    Examples:

    This is just a reference, the actual values may vary based on the service implementation. Return all items sorted by name in descending order and a secondary sort order of updatedAt in ascending order.

    $orderBy=name desc,updatedAt
    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    Responses

    Response samples

    Content type
    application/json
    {}

    Get a specific organization attachment

    Get an organization attachment

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token belongs to the organization
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    attachmentId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an attachment.

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "0123456789ab0123456789ab",
    • "orgId": "0123456789ab0123456789ab",
    • "ownerId": "0123456789ab0123456789ab",
    • "ownerType": "organization",
    • "isPublic": false,
    • "type": "jpg",
    • "url": "xxxx.com/yyyyy"
    }

    Delete a specific organization attachment

    Delete an organization attachment

    This operation requires

    • valid Authorization token has been specified in request header
    • Authorization token have super user permission or
      • userId inside Authorization token belongs to the organization
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    attachmentId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an attachment.

    Responses

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    Get attachment upload url

    Retrieves a list of attachment upload url. You need to specify a content length, and content type of the files you would like to upload After getting the upload url, you can upload the file to the url with PUT method, and the file will be uploaded to the cloud storage. After uploading the file, you need to call the create attachment api to create the attachment.

    Note that the file you upload later must much the content length and content type you specified in the query.

    Authorizations:
    x-nb-fingerprintbearerAuth
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    contentLength
    required
    number
    Example: contentLength=100000

    The contentLength of the object to upload

    contentType
    required
    string
    Example: contentType=image/png

    The contentType of the object to upload

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "0123456789ab0123456789ab",
    • "orgId": "0123456789ab0123456789ab",
    • "ownerId": "0123456789ab0123456789ab",
    • "ownerType": "organization",
    • "isPublic": false,
    • "type": "jpg",
    • "url": "xxxx.com/yyyyy"
    }

    User

    Check if user exist in the organization

    Check if user exist in the organization

    This operation requires

    • valid Authorization token has been specified in request header
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    userId
    required
    string

    UserId

    Responses

    Response samples

    Content type
    application/json
    {
    • "isUserInOrg": true
    }

    Follow

    Follow Organization

    Follow a organization

    This API is used to follow a organization. By passing the id in the body, the organization on the path will be followed.

    Required

    • followerId and followerType must be specified in the request body
    Authorizations:
    x-nb-fingerprintbearerAuth
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    Request Body schema: application/json
    followerId
    string (objectId.field) ^[0-9a-z]{24}$

    A 24 character hexadecimal string value.

    followerType
    string (followerType.field)
    Enum: "organization" "user"

    The type of entity that is following

    Responses

    Request samples

    Content type
    application/json
    {
    • "followerId": "0123456789ab0123456789ab",
    • "followerType": "organization"
    }

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    Unfollow organization

    Unfollow a organization

    This API is used to unfollow a organization. By passing the id in the body, the organization on the path will be unfollowed.

    Required

    • followerId and followerType must be specified in the request body
    Authorizations:
    x-nb-fingerprintbearerAuth
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    Request Body schema: application/json
    followerId
    string (objectId.field) ^[0-9a-z]{24}$

    A 24 character hexadecimal string value.

    followerType
    string (followerType.field)
    Enum: "organization" "user"

    The type of entity that is following

    Responses

    Request samples

    Content type
    application/json
    {
    • "followerId": "0123456789ab0123456789ab",
    • "followerType": "organization"
    }

    Response samples

    Content type
    application/json
    {
    • "error": {
      }
    }

    List organization followers

    Get organization follower list

    Validations

    • valid Authorization token have been specified in the request header
    • Authorization token is super user token or a system internal token
    Authorizations:
    bearerAuthx-nb-fingerprint
    path Parameters
    orgId
    required
    string^[0-9a-z]{24}$
    Example: 0123456789ab0123456789ab

    A unique identifier for an organization.

    query Parameters
    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    $nextToken
    string

    Token for get next batch of list data

    $previousToken
    string

    Token for get previous batch of list data

    $filter
    string

    Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

    Operator Description Example
    ( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
    not Logical negation not totalPrice le 3.5
    gt Greater than totalPrice gt 20
    ge Greater than or equal totalPrice ge 10
    lt Less than totalPrice lt 20
    le Less than or equal totalPrice le 100
    eq Equal customer.userId eq '01234567890123456789ab'
    ne Not equal status ne 'CANCELED'
    and Logical and totalPrice le 200 and totalPrice gt 3.5
    or Logical or totalPrice le 3.5 or totalPrice gt 200
    $orderBy
    string

    Return sorted items based on property values. It can contain a comma-separated list of expressions. The expression may include the suffix "asc" for ascending or "desc" for descending, separated from the property name by one or more spaces. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. The sort order is the inherent order for the type of the property.

    Examples:

    This is just a reference, the actual values may vary based on the service implementation. Return all items sorted by name in descending order and a secondary sort order of updatedAt in ascending order.

    $orderBy=name desc,updatedAt
    type
    required
    string
    Enum: "user" "organization" "product"

    Type of follower/follows to list

    Responses

    Response samples

    Content type
    application/json
    {}

    Get Follows

    Get the list of follow for organization by followerId

    This API gets a list of organizations that are being followed by an entity.

    For example, this can be used to fetch all organizations that are being followed by user

    Validations

    • valid Authorization token have been specified in the request header

    Required

    • followerId must be specified in the query
    • type must be specified in the query
    Authorizations:
    Nonex-nb-fingerprint
    query Parameters
    followerId
    required
    string

    follower id can be userId

    type
    required
    string
    Enum: "user" "organization" "product"

    Type of follower/follows to list

    $top
    integer

    number of object want to fetch

    $skip
    integer

    number of object want to skip

    $nextToken
    string

    Token for get next batch of list data

    $previousToken
    string

    Token for get previous batch of list data

    $filter
    string

    Return only items which matches to a condition (The operators below are listed in order of precedence from highest to lowest).

    Operator Description Example
    ( ) Precedence grouping (items.quantity eq 1 or items.productName eq 'T-Shirt') and totalPrice gt 100
    not Logical negation not totalPrice le 3.5
    gt Greater than totalPrice gt 20
    ge Greater than or equal totalPrice ge 10
    lt Less than totalPrice lt 20
    le Less than or equal totalPrice le 100
    eq Equal customer.userId eq '01234567890123456789ab'
    ne Not equal status ne 'CANCELED'
    and Logical and totalPrice le 200 and totalPrice gt 3.5
    or Logical or totalPrice le 3.5 or totalPrice gt 200
    $orderBy
    string

    Return sorted items based on property values. It can contain a comma-separated list of expressions. The expression may include the suffix "asc" for ascending or "desc" for descending, separated from the property name by one or more spaces. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. The sort order is the inherent order for the type of the property.

    Examples:

    This is just a reference, the actual values may vary based on the service implementation. Return all items sorted by name in descending order and a secondary sort order of updatedAt in ascending order.

    $orderBy=name desc,updatedAt
    type
    required
    string
    Enum: "user" "organization" "product"

    Type of follower/follows to list

    Responses

    Response samples

    Content type
    application/json
    {}